Skip to content

Commit b2aa1b8

Browse files
Charles7cCharles7c
committed
docs: 更新 Issue 模板
1 parent 58f7070 commit b2aa1b8

6 files changed

Lines changed: 207 additions & 131 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: "\U0001F41E 报告 Bug/Bug Report"
2+
description: 帮助我们更好地改进项目，但请先阅读官方文档及常见问题，不要提已有的重复问题！/Create a report to help us improve, please read FAQ first.
3+
labels:
4+
- bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢您使用 ContiNew Admin！请您花些时间填写这份 Bug 报告。前端项目 Bug 请提交至 [ContiNew Admin UI](https://github.com/continew-org/continew-admin-ui/issues/new/choose)。<br>
10+
**温馨提示：我们利用业余时间维护开源项目，没有额外精力及人员维护已发布版本，所以请务必检查【最新版本】是否正常，如已修复请自行跟进修复！**
11+
- type: checkboxes
12+
id: checkboxes
13+
attributes:
14+
label: 请您确认
15+
description: 在提交 Bug 之前，请先确认 :)
16+
options:
17+
- label: 我确认重启过项目和 IDE 后，仍然能够复现此问题
18+
required: true
19+
- label: 我确认尝试了最新 dev 分支代码（演示环境），仍有相同问题
20+
required: true
21+
- label: 我确认搜索了 [Issue 广场](https://continew.top/docs/admin/issue-hub.html)，没有其他人提交过类似的 Bug（如果对应 Bug 尚未解决，您可以先订阅关注该 Issue，为了方便后来者查找问题解决方法，请避免创建重复的 Issue）
22+
required: true
23+
- label: 我确认查阅过 [使用指南](https://continew.top/docs/admin/guide/introduction.html) 和 [常见问题](https://continew.top/docs/admin/faq.html)
24+
required: true
25+
- label: 我确认问过 [DeepWiki](https://deepwiki.com/continew-org/continew-admin) 及知名 AI 大模型
26+
required: true
27+
- label: 我确认不是依赖组件相关的 Bug（例如：sa-token、mybatis-plus、snail-job、cosid等，依赖组件相关的 Bug，请提交至对应组件仓库）
28+
required: true
29+
- label: 我尝试阅读了源码并在 IDE 中进行断点调试
30+
required: false
31+
- label: 我愿意为提出的 Bug 提交 PR 修复它
32+
required: false
33+
- label: 请不要修改此模板 :) 并填写所有必填字段
34+
required: true
35+
validations:
36+
required: true
37+
38+
- type: dropdown
39+
attributes:
40+
label: ContiNew Admin 版本
41+
description: 您使用的 ContiNew Admin 版本，如没有支持的版本选项，请查阅 [更新日志](https://continew.top/docs/admin/changelog/) 或 [版本升级指南](https://continew.top/docs/admin/guide/upgrade.html) 并升级至最新稳定版本。
42+
multiple: false
43+
options:
44+
- 4.2.0-SNAPSHOT (开发版本-dev 分支)
45+
- 4.1.0
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: bug-description
51+
attributes:
52+
label: Bug 描述
53+
description: 清楚而简洁地描述您遇到的 Bug。
54+
placeholder: 例如：在使用 xxx 功能时出现异常
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: reproduction
60+
attributes:
61+
label: 复现步骤
62+
description: 强烈建议附上截图和完整错误日志！代码块请使用正确的 Markdown 格式。
63+
placeholder: 详细的步骤有助于我们复现问题。如有日志，请使用代码块格式（三个反引号 ```），如截图中存在敏感信息，请注意添加马赛克脱敏。
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: expected
69+
attributes:
70+
label: 预期结果
71+
description: 清楚而简洁地描述您期望的结果。
72+
placeholder: 你期望的是什么？请不要在这里复制粘贴复现步骤。
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: environment-info
78+
attributes:
79+
label: 环境信息
80+
description: 添加一切能帮助定位问题的环境信息。
81+
placeholder: 例如：JDK 版本：17，Maven 版本：3.6.3；MySQL 版本：8.0.33
82+
validations:
83+
required: false

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 0 additions & 77 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "\U0001F510 安全漏洞"
4+
url: "https://github.com/continew-org/continew-admin/security/advisories/new"
5+
about: 通过 GitHub 安全通告来报告安全漏洞，以确保负责任的披露。💡 请勿在公开 Issue 中报告安全漏洞！
6+
- name: "\U0001F4A1 DeepWiki AI"
7+
url: "https://deepwiki.com/continew-org/continew-admin"
8+
about: 使用 AI 快速搜索项目代码和文档，获取精准的代码解释和技术解答
9+
- name: "\U0001F4DD ContiNew Admin 官方文档"
10+
url: https://continew.top/docs/admin/guide/quick-start.html
11+
about: 提供项目使用指南、教程和常见问题解答，ContiNew Admin 系统基本功能使用、介绍
12+
- name: "\U0001F4AC ContiNew Admin 官方交流群"
13+
url: https://continew.top/discussion.html
14+
about: 扫码加入官方微信交流群，获取第一手项目动态，结识志同道合的技术爱好者

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "\U00002728 期望新增功能/Feature Request"
2+
description: 期望新增什么样的功能或特性，或者做哪些方面的改进？/Suggest an enhancement or new feature.
3+
labels:
4+
- feature
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢您使用 ContiNew Admin！请您花些时间填写这份 Feature 调查。前端项目 Feature 请提交至 [ContiNew Admin UI](https://github.com/continew-org/continew-admin-ui/issues/new/choose)。<br>
10+
**温馨提示：我们利用业余时间维护开源项目，没有额外精力及人员开发特定业务功能，如业务仅为小众需求，请确认是否有必要提交！**
11+
- type: checkboxes
12+
id: checkboxes
13+
attributes:
14+
label: 请您确认
15+
description: 在提交 Feature 之前，请先确认 :)
16+
options:
17+
- label: 我确认尝试了最新 dev 分支代码（演示环境），仍没有该功能
18+
required: true
19+
- label: 我确认查阅过 [使用指南](https://continew.top/docs/admin/guide/introduction.html) 和 [常见问题](https://continew.top/docs/admin/faq.html) ，仍然认为很有必要
20+
required: true
21+
- label: 我确认搜索了 [Issue 广场](https://continew.top/docs/admin/issue-hub.html)，没有其他人提交过类似的 Feature（如果对应 Feature 尚未实现，您可以先订阅关注该 Issue，为了方便后来者查找问题解决方法，请避免创建重复的 Issue）
22+
required: true
23+
- label: 我确认不是依赖组件相关的需求（例如：sa-token、mybatis-plus、snail-job、cosid等，如有此类组件相关的需求，请提交至对应组件仓库）
24+
required: true
25+
- label: 我愿意为提出的 Feature 提交 PR 实现它
26+
required: false
27+
- label: 请不要修改此模板 :) 并填写所有必填字段
28+
required: true
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: feature-description
34+
attributes:
35+
label: Feature 描述
36+
description: 清楚而简洁地描述您的 Feature。
37+
placeholder: 例如：我希望增加 xxx 功能；现有的 xxx 功能不好用...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: suggested-solution
43+
attributes:
44+
label: 描述一下您想要的解决方案
45+
description: 清楚而简洁地描述您想要的解决方案。
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: alternative
51+
attributes:
52+
label: 描述一下您考虑过的替代方案
53+
description: 清楚而简洁地描述您考虑过的任何替代解决方案或功能。
54+
55+
- type: textarea
56+
id: additional-context
57+
attributes:
58+
label: 额外补充
59+
description: 添加您在其他框架或场景遇见的效果截图或链接，以及一切能帮助理解 Feature 的信息。

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: "🙋 咨询问题/Ask Question"
2+
description: 咨询关于 ContiNew Admin 的问题，包括但不限于使用问题、部署问题、设计规范等。/Ask a question about ContiNew Admin.
3+
labels:
4+
- question
5+
body:
6+
- type: checkboxes
7+
id: checkboxes
8+
attributes:
9+
label: 请您确认
10+
description: 在提交问题之前，请先确认 :)
11+
options:
12+
- label: 我确认是咨询问题而不是报告 Bug（如果是报告 Bug，请选择 Bug 模板）
13+
required: true
14+
- label: 我确认搜索了 [Issue 广场](https://continew.top/docs/admin/issue-hub.html)，没有其他人提交过类似的问题
15+
required: true
16+
- label: 我确认查阅过 [使用指南](https://continew.top/docs/admin/guide/introduction.html) 和 [常见问题](https://continew.top/docs/admin/faq.html)
17+
required: true
18+
- label: 我确认问过 [DeepWiki](https://deepwiki.com/continew-org/continew-admin) 及知名 AI 大模型
19+
required: true
20+
- label: 我确认不是依赖组件相关的问题（例如：sa-token、mybatis-plus、snail-job、cosid等，依赖组件相关的问题，请提交至对应组件仓库）
21+
required: true
22+
- label: 请不要修改此模板 :) 并填写所有必填字段
23+
required: true
24+
25+
- type: dropdown
26+
attributes:
27+
label: ContiNew Admin 版本
28+
description: 您使用的 ContiNew Admin 版本，如没有支持的版本选项，请查阅 [更新日志](https://continew.top/docs/admin/changelog/) 或 [版本升级指南](https://continew.top/docs/admin/guide/upgrade.html) 并升级至最新稳定版本。
29+
multiple: false
30+
options:
31+
- 4.2.0-SNAPSHOT (开发版本-dev 分支)
32+
- 4.1.0
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: feature-description
38+
attributes:
39+
label: 问题描述
40+
description: 详细描述您的问题。
41+
placeholder: 您想了解关于 ContiNew Admin 的哪些内容？请提供尽可能多的上下文信息。
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
attributes:
47+
label: 您已尝试的方法
48+
description: 描述您已尝试的方法，包括但不限于尝试解决方案等。
49+
placeholder: 您是否已尝试过任何解决方案？
50+
validations:
51+
required: false

0 commit comments

Comments
 (0)