mirror of
https://github.com/continew-org/continew-admin.git
synced 2025-10-31 10:57:13 +08:00
chore: 优化 GitHub Issue 模板
This commit is contained in:
@@ -1,46 +0,0 @@
|
||||
<!--
|
||||
感谢您使用 ContiNew Admin！请您花些时间填写这份 Issue 调查，非常感谢您的反馈！
|
||||
-->
|
||||
|
||||
<!-- 在 [] 中输入 x 来勾选) -->
|
||||
|
||||
## Issue 类型
|
||||
|
||||
- [ ] 缺陷报告（Bug）
|
||||
- [ ] 需求建议（Feature）
|
||||
|
||||
## Issue 描述
|
||||
|
||||
<!-- 清楚而简洁地描述您遇到的问题。例如：在使用 xxx 功能时发现 xxx 问题。另外，非常欢迎您对此 Issue 提交 PR。 -->
|
||||
|
||||
## 复现步骤（如果是提交 Feature Issue，请删除本项）
|
||||
|
||||
<!-- 条理清晰的步骤或演示视频可以帮助快速定位问题。例如：1、xxx; 2、xxx; -->
|
||||
|
||||
## 预期结果（如果是提交 Feature Issue，请删除本项）
|
||||
|
||||
<!-- 清楚而简洁地描述您期望的结果。 -->
|
||||
|
||||
## 环境信息（如果是提交 Feature Issue，请删除本项）
|
||||
|
||||
<!-- 描述清楚您所使用的相关环境，例如：JDK 版本：1.8.0_202；框架版本：v1.0.0；其他可能与该 issue 相关的依赖版本。 -->
|
||||
|
||||
## 解决方案（如果是提交 Bug Issue，请删除本项）
|
||||
|
||||
<!-- 清楚而简洁地描述您想要的解决方案。 -->
|
||||
|
||||
## 替代方案（如果是提交 Bug Issue，请删除本项）
|
||||
|
||||
<!-- 清楚而简洁地描述您考虑过的任何替代解决方案或功能。 -->
|
||||
|
||||
## 额外补充
|
||||
|
||||
<!-- Bug：添加您的完整报错信息或屏幕截图，以及一切能帮助定位问题的信息。 -->
|
||||
<!-- Feature：添加您在其他框架或场景遇见的效果截图或链接，以及一切能帮助理解 Feature 的信息。 -->
|
||||
|
||||
## 提交前确认
|
||||
|
||||
<!-- 在提交 issue 之前，请确保执行过以下操作。 -->
|
||||
|
||||
- [ ] 阅读[文档](https://continew.top/admin/other/faq.html)
|
||||
- [ ] 搜索是否有其他人提交过类似的 issue，如果对应 issue 尚未解决，您可以先订阅关注该 issue（为了方便后来者查找问题解决方法，请尽量避免创建重复的 issue）
|
||||
@@ -1,53 +0,0 @@
|
||||
<!--
|
||||
非常感谢您的 PR！在提交之前，请务必确保您 PR 的代码经过了完整测试，并且通过了代码规范检查。
|
||||
-->
|
||||
|
||||
<!-- 在 [] 中输入 x 来勾选) -->
|
||||
|
||||
## PR 类型
|
||||
|
||||
<!-- 您的 PR 引入了哪种类型的变更？ -->
|
||||
<!-- 只支持选择一种类型，如果有多种类型，可以在更新日志中增加 “类型” 列。 -->
|
||||
|
||||
- [ ] 新 feature
|
||||
- [ ] Bug 修复
|
||||
- [ ] 功能增强
|
||||
- [ ] 文档变更
|
||||
- [ ] 代码样式变更
|
||||
- [ ] 重构
|
||||
- [ ] 性能改进
|
||||
- [ ] 单元测试
|
||||
- [ ] CI/CD
|
||||
- [ ] 其他
|
||||
|
||||
## PR 目的
|
||||
|
||||
<!-- 描述一下您的 PR 解决了什么问题。如果可以，请链接到相关 issues。 -->
|
||||
|
||||
## 解决方案
|
||||
|
||||
<!-- 详细描述您是如何解决的问题 -->
|
||||
|
||||
## PR 测试
|
||||
|
||||
<!-- 如果可以，请为您的 PR 添加或更新单元测试。 -->
|
||||
<!-- 请描述一下您是如何测试 PR 的。例如：创建/更新单元测试或添加相关的截图。 -->
|
||||
|
||||
## Changelog
|
||||
|
||||
| 模块 | Changelog | Related issues |
|
||||
|-----|-----------| -------------- |
|
||||
| | | |
|
||||
|
||||
<!-- 如果有多种类型的变更，可以在变更日志表中增加 “类型” 列，该列的值与上方 “PR 类型” 相同。 -->
|
||||
<!-- Related issues 格式为 fixes #<issue号>，或者 resolves #<issue号>。 -->
|
||||
|
||||
## 其他信息
|
||||
|
||||
<!-- 请描述一下还有哪些注意事项。例如：如果引入了一个不向下兼容的变更，请描述其影响。 -->
|
||||
|
||||
## 提交前确认
|
||||
|
||||
- [ ] PR 代码经过了完整测试，并且通过了代码规范检查
|
||||
- [ ] 已经完整填写 Changelog，并链接到了相关 issues
|
||||
- [ ] PR 代码将要提交到 dev 分支
|
||||
10
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
10
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@@ -1,6 +1,7 @@
|
||||
name: "\U0001F41E Bug 报告"
|
||||
description: Create a report to help us improve
|
||||
labels: ['bug: pending triage']
|
||||
title: "[Bug] "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
@@ -34,8 +35,11 @@ body:
|
||||
id: environment-info
|
||||
attributes:
|
||||
label: 环境信息
|
||||
description: 描述清楚您所使用的相关环境，例如：JDK 版本：1.8.0_202；框架版本：v1.0.0；其他可能与该 issue 相关的依赖版本。
|
||||
placeholder: JDK 版本, 框架版本等
|
||||
description: |
|
||||
examples:
|
||||
- **ContiNew Admin version(s)**: v3.0.1
|
||||
value: "ContiNew Admin version(s):"
|
||||
render: markdown
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
|
||||
4
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
4
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@@ -1,5 +1,7 @@
|
||||
name: "\U0001F680 新 Feature 建议"
|
||||
description: Suggest an idea for this project
|
||||
title: "[Feature] "
|
||||
labels: ["feature"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
@@ -40,3 +42,5 @@ body:
|
||||
required: true
|
||||
- label: 搜索是否有其他人提交过类似的 issue，如果对应 issue 尚未解决，您可以先订阅关注该 issue（为了方便后来者查找问题解决方法，请尽量避免创建重复的 issue）
|
||||
required: true
|
||||
- label: 您是否愿意为您提出的 Feature 提交 PR？
|
||||
required: false
|
||||
Reference in New Issue
Block a user