chore: 新增 Issue 及 PR 模板

This commit is contained in:
2024-04-17 21:13:58 +08:00
parent 4983dd1aa0
commit 73ea05c01b
5 changed files with 251 additions and 0 deletions

57
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,57 @@
name: "\U0001F41E Bug 报告"
description: Create a report to help us improve
labels: ['bug: pending triage']
body:
- type: markdown
attributes:
value: |
感谢您使用 ContiNew Admin请您花些时间填写这份 Bug 报告。
- type: textarea
id: bug-description
attributes:
label: Bug 描述
description: 清楚而简洁地描述您遇到的 Bug。另外非常欢迎您对此 Bug 提交 PR。
placeholder: 例如:在使用 xxx 功能时出现异常
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: 复现步骤
description: 条理清晰的步骤或演示视频可以帮助快速定位问题。
placeholder: 例如1、xxx; 2、xxx;
validations:
required: true
- type: textarea
id: expected
attributes:
label: 预期结果
description: 清楚而简洁地描述您期望的结果。
placeholder: 预期结果
validations:
required: true
- type: textarea
id: environment-info
attributes:
label: 环境信息
description: 描述清楚您所使用的相关环境例如Node 版本xxxx框架版本v1.0.0;其他可能与该 issue 相关的依赖版本。
placeholder: Node 版本, 框架版本等
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: 额外补充
description: 添加您的完整报错信息或屏幕截图,以及一切能帮助定位问题的信息。
- type: checkboxes
id: checkboxes
attributes:
label: 确认
description: 在提交 issue 之前,请确保执行过以下操作。
options:
- label: 阅读[文档](https://doc.charles7c.top/admin/other/faq.html)
required: true
- label: 根据报错信息百度或 Google 一下
required: true
- label: 搜索是否有其他人提交过类似的 issue如果对应 issue 尚未解决,您可以先订阅关注该 issue为了方便后来者查找问题解决方法请尽量避免创建重复的 issue
required: true

View File

@@ -0,0 +1,42 @@
name: "\U0001F680 新 Feature 建议"
description: Suggest an idea for this project
body:
- type: markdown
attributes:
value: |
感谢您使用 ContiNew Admin请您花些时间填写这份 Feature 调查。
- type: textarea
id: feature-description
attributes:
label: Feature 描述
description: 清楚而简洁地描述您的 Feature。另外非常欢迎您对此 Feature 提交 PR。
placeholder: 例如:我希望增加 xxx 功能;现有的 xxx 功能不好用...
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: 描述一下您想要的解决方案
description: 清楚而简洁地描述您想要的解决方案。
validations:
required: true
- type: textarea
id: alternative
attributes:
label: 描述一下您考虑过的替代方案
description: 清楚而简洁地描述您考虑过的任何替代解决方案或功能。
- type: textarea
id: additional-context
attributes:
label: 额外补充
description: 添加您在其他框架或场景遇见的效果截图或链接,以及一切能帮助理解 Feature 的信息。
- type: checkboxes
id: checkboxes
attributes:
label: 确认
description: 在提交 issue 之前,请确保执行过以下操作。
options:
- label: 阅读[文档](https://doc.charles7c.top/admin/intro/require.html)
required: true
- label: 搜索是否有其他人提交过类似的 issue如果对应 issue 尚未解决,您可以先订阅关注该 issue为了方便后来者查找问题解决方法请尽量避免创建重复的 issue
required: true