diff --git a/.gitee/ISSUE_TEMPLATE.zh-CN.md b/.gitee/ISSUE_TEMPLATE.zh-CN.md index ee2f770..632eb45 100644 --- a/.gitee/ISSUE_TEMPLATE.zh-CN.md +++ b/.gitee/ISSUE_TEMPLATE.zh-CN.md @@ -3,8 +3,16 @@ 历史版本的问题官方将拒绝处理。 ### 该问题是怎么引起的(如果最新版本已经修复的,会直接关闭)? - - +编写关于整个issue描述前注意阅读下面的注意事项,尤其是萌新的同学: +1. 提issue时请认真阅读官方的wiki文档及相关配置说明,少给开源软件提无效的issue是一个IT从业人的专业素养。 +2. 提某些简单使用问题的issue时请先思考,smart-doc从18年开源以来已经有很多企业使用,码云的指数也很高。 + 很多问题都已解决,开源玩具是走不进企业的。请仔细阅读文档找到相关解决方法。 +3. 当你提出问题时尽量思考你的描述信息能否让官方人员复现。不要随便扔个报错信息出来就把开源人当神仙了。 + smart-doc是一款很依赖你本地环境和代码数据的工具。官方人员并没有你的代码数据和模拟相同环境。 + 因此建议你经常先自己debug,官方的wiki也有详细的介绍怎么去debug smart-doc或smart-doc的相关插件, + 不要说你不懂。 + + 最后、祝你使用愉快! ### 重现步骤