update bug report template

This commit is contained in:
oppofind 2020-12-06 13:37:55 +08:00
parent 0d746c4d14
commit 9da085ea13
4 changed files with 18 additions and 12 deletions

View File

@ -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)
### 报错信息
### 报错信息(必填,不填写官方直接关闭issue)

View File

@ -5,6 +5,12 @@ title: ''
labels: bug
assignees: ''
---
## Your Environment(您的使用环境)
<!--- Include as many relevant details about the environment you experienced the bug in -->
* smart-doc version:
* plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin):
* build tool version(maven or gradle):
## Expected Behavior(您期望的结果)
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->
@ -29,9 +35,5 @@ assignees: ''
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
## Your Environment(您的使用环境)
<!--- Include as many relevant details about the environment you experienced the bug in -->
* smart-doc version:
* plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin):
* build tool version(maven or gradle):

View File

@ -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

View File

@ -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}$