From 73ea05c01b56eb59d520d8f1338db51f16577d0a Mon Sep 17 00:00:00 2001 From: Charles7c Date: Wed, 17 Apr 2024 21:13:58 +0800 Subject: [PATCH] =?UTF-8?q?chore:=20=E6=96=B0=E5=A2=9E=20Issue=20=E5=8F=8A?= =?UTF-8?q?=20PR=20=E6=A8=A1=E6=9D=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitee/ISSUE_TEMPLATE.zh-CN.md | 46 +++++++++++++++++ .gitee/PULL_REQUEST_TEMPLATE.zh-CN.md | 53 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 57 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 42 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 53 ++++++++++++++++++++ 5 files changed, 251 insertions(+) create mode 100644 .gitee/ISSUE_TEMPLATE.zh-CN.md create mode 100644 .gitee/PULL_REQUEST_TEMPLATE.zh-CN.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.gitee/ISSUE_TEMPLATE.zh-CN.md b/.gitee/ISSUE_TEMPLATE.zh-CN.md new file mode 100644 index 0000000..927cdeb --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE.zh-CN.md @@ -0,0 +1,46 @@ + + + + +## Issue 类型 + +- [ ] 缺陷报告（Bug） +- [ ] 需求建议（Feature） + +## Issue 描述 + + + +## 复现步骤（如果是提交 Feature Issue，请删除本项） + + + +## 预期结果（如果是提交 Feature Issue，请删除本项） + + + +## 环境信息（如果是提交 Feature Issue，请删除本项） + + + +## 解决方案（如果是提交 Bug Issue，请删除本项） + + + +## 替代方案（如果是提交 Bug Issue，请删除本项） + + + +## 额外补充 + + + + +## 提交前确认 + + + +- [ ] 阅读[文档](https://doc.charles7c.top/admin/other/faq.html) +- [ ] 搜索是否有其他人提交过类似的 issue，如果对应 issue 尚未解决，您可以先订阅关注该 issue（为了方便后来者查找问题解决方法，请尽量避免创建重复的 issue） \ No newline at end of file diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md new file mode 100644 index 0000000..1d7cdfa --- /dev/null +++ b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md @@ -0,0 +1,53 @@ + + + + +## PR 类型 + + + + +- [ ] 新 feature +- [ ] Bug 修复 +- [ ] 功能增强 +- [ ] 文档变更 +- [ ] 代码样式变更 +- [ ] 重构 +- [ ] 性能改进 +- [ ] 单元测试 +- [ ] CI/CD +- [ ] 其他 + +## PR 目的 + + + +## 解决方案 + + + +## PR 测试 + + + + +## Changelog + +| 模块 | Changelog | Related issues | +|-----|-----------| -------------- | +| | | | + + + + +## 其他信息 + + + +## 提交前确认 + +- [ ] PR 代码经过了完整测试，并且通过了代码规范检查 +- [ ] 已经完整填写 Changelog，并链接到了相关 issues +- [ ] PR 代码将要提交到 dev 分支 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..b1187c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1d3b258 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e0fe589 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,53 @@ + + + + +## PR 类型 + + + + +- [ ] 新 feature +- [ ] Bug 修复 +- [ ] 功能增强 +- [ ] 文档变更 +- [ ] 代码样式变更 +- [ ] 重构 +- [ ] 性能改进 +- [ ] 单元测试 +- [ ] CI/CD +- [ ] 其他 + +## PR 目的 + + + +## 解决方案 + + + +## PR 测试 + + + + +## Changelog + +| 模块 | Changelog | Related issues | +|-----|-----------| -------------- | +| | | | + + + + +## 其他信息 + + + +## 提交前确认 + +- [ ] PR 代码经过了完整测试，并且通过了代码规范检查 +- [ ] 已经完整填写 Changelog，并链接到了相关 issues +- [ ] PR 代码将要提交到 dev 分支 \ No newline at end of file