[DOC] add the issue template for gitee

Learnware-LAMDA · Jan 14, 2024 · 18c0943 · 18c0943
1 parent 0cbcbf3
commit 18c0943
Show file tree

Hide file tree

Showing 4 changed files with 92 additions and 0 deletions.
diff --git a/.gitee/ISSUE_TEMPLATE/bug-report.yml b/.gitee/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,38 @@
+name: "\U0001F41B 错误报告"
+description: 提交错误报告以帮助我们改进北冥坞系统
+body:
+ - type: textarea
+ id: system-info
+ attributes:
+ label: 系统配置
+ description: 请与我们分享你的系统配置信息.
+ placeholder: learnware 版本, 使用的平台, python 版本, ...
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ validations:
+ required: true
+ attributes:
+ label: 可复现示例
+ description: |
+ 请提供可以复现你遇到的问题的代码示例. 它可以是 Colab 链接或一个代码片段.
+ 如果你有代码片段或相关错误消息，请在此处提供.
+ 提示: 请使用代码标签正确格式化代码, 可以参考 [代码块指南](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting).
+ 请不要使用截图, 因为截图很难阅读且无法复制代码.
+
+ placeholder: |
+ 复现的步骤:
+ 
+ 1.
+ 2.
+ 3.
+ 
+ - type: textarea
+ id: expected-behavior
+ validations:
+ required: true
+ attributes:
+ label: 期望结果
+ description: "请描述上述代码示例, 期望产生的结果."
diff --git a/.gitee/ISSUE_TEMPLATE/documentation.yml b/.gitee/ISSUE_TEMPLATE/documentation.yml
@@ -0,0 +1,12 @@
+name: "\U0001F4D6 文档"
+description: 提交与文档相关的问题
+labels: [ "documentation" ]
+body:
+ - type: textarea
+ id: description
+ validations:
+ required: true
+ attributes:
+ label: 具体描述
+ description: |
+ 请清晰地描述你的问题.
diff --git a/.gitee/ISSUE_TEMPLATE/feature-request.yml b/.gitee/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,30 @@
+name: "\U0001F680 功能建议"
+description: 提交关于 Learnware 新功能的建议
+labels: [ "feature" ]
+body:
+ - type: textarea
+ id: feature-request
+ validations:
+ required: true
+ attributes:
+ label: 功能建议
+ description: |
+ 对所建议功能的清晰且简洁的描述. 请提供相关论文和代码的链接 (如果有).
+
+ - type: textarea
+ id: motivation
+ validations:
+ required: true
+ attributes:
+ label: 动机
+ description: |
+ 请概述建议该功能的动机. 你的建议是否与某个问题有关? 如果这与另一个 Gitee 问题有关, 请在此处给出相关链接.
+
+ - type: textarea
+ id: contribution
+ validations:
+ required: true
+ attributes:
+ label: 你的贡献
+ description: |
+ 你是否可以提供帮助, 例如提交 PR? 提交前请确保已阅读 [开发者指南](https://gitee.com/beimingwu/learnware/blob/main/docs/about/dev.rst).
diff --git a/.gitee/ISSUE_TEMPLATE/question.yml b/.gitee/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,12 @@
+name: "\U00002753 问题 & 帮助"
+description: 是否有相关问题? 我们可以提供帮助
+labels: [ "question" ]
+body:
+ - type: textarea
+ id: question
+ validations:
+ required: true
+ attributes:
+ label: 具体描述
+ description: |
+ 我们真诚地建议你仔细阅读我们项目的文档. 之后如果仍有相关困惑, 请在此问题下清晰地描述你的问题.