diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d774706..3bb3b7f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,20 @@ # 🍀 提 Issue 的正确方式 -## 标题 -为了保持 Issues 区域版面整洁可读, 创建 Issue 时,**标题应尽量言简意赅** (一句话概括问题) +## 自助 -## 说明 +创建 Issue 前,为了避免议题重复而造成大家不必要的消耗,您可以先尝试通过以下渠道寻找解决方案: -创建 Issue 时,**[内容请按照文本框中的文字模板规范填写(点击查看示例)](https://foruda.gitee.com/images/1660197253451887123/%E5%B1%8F%E5%B9%95%E6%88%AA%E5%9B%BE.png)**,尽量将您所遇到的问题描述详细,如: +- 仔细查看 Layui 官方文档,大部分问题都能通过文档找到答案:https://layui.dev +- 在 Issues 中搜索类似问题,基本上都有相关回复 -- **版本:** 提供所使用的 Layui 版本号。 -- **描述:** 提供尽可能详细的问题描述和具体操作步骤等信息,以便我们也能够更轻松地将问题复现。 -- **代码:** 提供与问题对应的业务代码,以便我们更好排查。 -- **补充:** 如若必要,还可以提供其他补充,如截图等信息。 +## 创建 -> 按照模板规范填写的初衷,是为了减少大家不必要的时间消耗,还望遵循并理解 +若上述渠道未能找到解决方案,那么创建 Issue 时,**请按照表单模板规范逐一填写**。 +其中,标题应尽量言简意赅(一句话概括议题),其他表单项则尽量将您所遇到的问题描述详细。 -- **若 Issue 未遵循模板规范,可能将无法获得相关回答,敬请知晓** -- 若 issue 是建议/分享/讨论性质的 ,则可以自由发挥 +> **若 Issue 未遵循模板规范仔细填写,可能将无法获得相关回答,敬请知晓和理解** ## 对接 -- 在 Issue 交流过程中,若问题已经得到解决,或 Issue 并非项目相关的问题,请及时将状态设置为 「已完成」 -- 大家本着相互尊重、理解和友善的态度进行交流,共同维护好 Layui 来之不易的良好社区氛围。谢谢 :sparkling_heart: \ No newline at end of file +- 在 Issue 交流过程中,若议题已经得到解决,或 Issue 并非项目相关问题,请在 Issue 右上角将状态设置为:已完成 +- 大家本着相互尊重、理解和友善的态度进行交流,共同维护好 Layui 来之不易的良好的社区氛围。谢谢