layui/CONTRIBUTING.md

23 lines
1.3 KiB
Markdown
Raw Normal View History

2023-04-11 00:27:43 +08:00
# 🍀 提 Issue 的正确方式
2022-07-21 15:03:48 +08:00
2022-07-21 15:14:30 +08:00
## 标题
2023-04-11 00:27:43 +08:00
为了保持 Issues 区域版面整洁可读, 创建 Issue 时,**标题应尽量言简意赅** (一句话概括问题)
2022-07-21 15:03:48 +08:00
2022-07-21 15:14:30 +08:00
## 说明
2022-07-21 15:03:48 +08:00
2023-04-11 00:27:43 +08:00
创建 Issue 时,**[内容请按照文本框中的文字模板规范填写(点击查看示例)](https://foruda.gitee.com/images/1660197253451887123/%E5%B1%8F%E5%B9%95%E6%88%AA%E5%9B%BE.png)**,尽量将您所遇到的问题描述详细,如:
2022-07-21 15:03:48 +08:00
- **版本:** 提供所使用的 Layui 版本号。
- **描述:** 提供尽可能详细的问题描述和具体操作步骤等信息,以便我们也能够更轻松地将问题复现。
- **代码:** 提供与问题对应的业务代码,以便我们更好排查。
- **补充:** 如若必要,还可以提供其他补充,如截图等信息。
2023-04-11 00:27:43 +08:00
> 按照模板规范填写的初衷,是为了减少大家不必要的时间消耗,还望遵循并理解
2022-09-02 13:35:20 +08:00
2023-04-11 00:27:43 +08:00
- **若 Issue 未遵循模板规范,可能将无法获得相关回答,敬请知晓**
- 若 issue 是建议/分享/讨论性质的 ,则可以自由发挥
2022-09-02 13:35:20 +08:00
2022-07-21 15:14:30 +08:00
## 对接
2022-07-21 15:03:48 +08:00
2023-04-11 00:27:43 +08:00
- 在 Issue 交流过程中,若问题已经得到解决,或 Issue 并非项目相关的问题,请及时将状态设置为 「已完成」
2022-09-02 13:35:20 +08:00
- 大家本着相互尊重、理解和友善的态度进行交流,共同维护好 Layui 来之不易的良好社区氛围。谢谢 :sparkling_heart: