From 9da085ea133606a07561f62c87ad6f56346cf462 Mon Sep 17 00:00:00 2001 From: oppofind <836575280@qq.com> Date: Sun, 6 Dec 2020 13:37:55 +0800 Subject: [PATCH] update bug report template --- .gitee/ISSUE_TEMPLATE.zh-CN.md | 14 +++++++++----- .github/ISSUE_TEMPLATE/bug_report.md | 12 +++++++----- README.md | 2 +- README_CN.md | 2 +- 4 files changed, 18 insertions(+), 12 deletions(-) diff --git a/.gitee/ISSUE_TEMPLATE.zh-CN.md b/.gitee/ISSUE_TEMPLATE.zh-CN.md index cc62c10..b3c984e 100644 --- a/.gitee/ISSUE_TEMPLATE.zh-CN.md +++ b/.gitee/ISSUE_TEMPLATE.zh-CN.md @@ -1,6 +1,10 @@ -### 当前使用版本(必须填写清楚,否则不予处理) -注意:请自行从maven仓库或者是[github](https://github.com/smart-doc-group/smart-doc) tag确认你当前使用的是最新版的smart-doc或者相关插件, -历史版本的问题官方将拒绝处理。 +### 您的使用环境(必填,不填写官方直接关闭issue) +maven和gradle版本信息根据个人使用情况填写 + +- maven版本号:xxx +- smart-doc-maven-plugin版本号:xxx +- gradle版本号:xxx +- smart-doc-gradle-plugin版本号:xxx ### 该问题是怎么引起的(如果最新版本已经修复的,会直接关闭)? 编写关于整个issue描述前注意阅读下面的注意事项,尤其是萌新的同学: @@ -13,7 +17,7 @@ 文档把调试步骤都写了,不要说你不懂。 最后、祝你使用愉快! -### 重现步骤 +### 重现步骤(必填,不填写官方直接关闭issue) -### 报错信息 \ No newline at end of file +### 报错信息(必填,不填写官方直接关闭issue) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c6f8d10..da09d08 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -5,6 +5,12 @@ title: '' labels: bug assignees: '' --- +## Your Environment(您的使用环境) + +* smart-doc version: +* plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin): +* build tool version(maven or gradle): + ## Expected Behavior(您期望的结果) @@ -29,9 +35,5 @@ assignees: '' -## Your Environment(您的使用环境) - -* smart-doc version: -* plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin): -* build tool version(maven or gradle): + diff --git a/README.md b/README.md index 666bbbd..ac1d81a 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ smart-doc does not need to inject annotations into the code like Swagger. - Support for automatic generation of request examples based on request parameters. - Support for generating JSON return value examples. - Support for loading source code from outside the project to generate field comments (including the sources jar package). -- Support for generating multiple formats of documents: Markdown,HTML5,Asciidoctor,Postman Collection,OpenAPI 3.0. +- Support for generating multiple formats of documents: Markdown,HTML5,Asciidoctor,Postman Collection 2.0+,OpenAPI 3.0. - Support for exporting error codes and data dictionary codes to API documentation. - Support Apache Dubbo RPC. ## Getting Started diff --git a/README_CN.md b/README_CN.md index 8ecf429..146acfa 100644 --- a/README_CN.md +++ b/README_CN.md @@ -8,7 +8,7 @@ ## Introduce smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释, -smart-doc就能帮你生成一个简易明了的Markdown、HTML5文档,甚至可以直接生成Postman Collection导入到Postman做API接口调试。 +smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。 $\color{red}{你给我的star,胜过所有读过的诗—smart-doc}$