Browse Source

[MNT] modift issue template

tags/v0.3.2
bxdd 2 years ago
parent
commit
da50a4c5b4
4 changed files with 25 additions and 78 deletions
  1. +10
    -28
      .gitee/ISSUE_TEMPLATE/bug-report.yml
  2. +3
    -12
      .gitee/ISSUE_TEMPLATE/feature-request.yml
  3. +9
    -27
      .github/ISSUE_TEMPLATE/bug-report.yml
  4. +3
    -11
      .github/ISSUE_TEMPLATE/feature-request.yml

+ 10
- 28
.gitee/ISSUE_TEMPLATE/bug-report.yml View File

@@ -1,38 +1,20 @@
name: "\U0001F41B 错误报告"
description: 提交错误报告以帮助我们改进北冥坞系统
body:
- type: textarea
id: system-info
- type: textarea
id: bug-detail
attributes:
label: 系统配置
description: 请与我们分享你的系统配置信息.
placeholder: learnware 版本, 使用的平台, python 版本, ...
label: 错误信息
description: 请描述你所遇到的错误,并且可以提供用于复现错误的代码或者运行截图.
placeholder: 错误描述和复现方法.
validations:
required: true
- type: textarea
id: reproduction
validations:
required: true
id: env-info
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
label: 环境配置
description: 请与我们分享你的环境配置信息.
placeholder: learnware 版本, 使用的平台, python 版本, 等等.
validations:
required: true
attributes:
label: 期望结果
description: "请描述上述代码示例, 期望产生的结果."
required: true

+ 3
- 12
.gitee/ISSUE_TEMPLATE/feature-request.yml View File

@@ -7,18 +7,9 @@ body:
validations:
required: true
attributes:
label: 功能建议
label: 功能描述
description: |
对所建议功能的清晰且简洁的描述. 请提供相关论文和代码的链接 (如果有).
- type: textarea
id: motivation
validations:
required: true
attributes:
label: 动机
description: |
请概述建议该功能的动机. 你的建议是否与某个问题有关? 如果这与另一个 Gitee 问题有关, 请在此处给出相关链接.
对所建议功能的清晰且简洁的描述. 如何该功能和其他论文、代码或者 Issues 相关,可以提供相应的链接.
- type: textarea
id: contribution
@@ -27,4 +18,4 @@ body:
attributes:
label: 你的贡献
description: |
你是否可以提供帮助, 例如提交 PR? 提交前请确保已阅读 [开发者指南](https://gitee.com/beimingwu/learnware/blob/main/docs/about/dev.rst).
你是否可以提供帮助, 例如提交 PR?

+ 9
- 27
.github/ISSUE_TEMPLATE/bug-report.yml View File

@@ -2,37 +2,19 @@ name: "\U0001F41B Bug Report"
description: Submit a bug report to help us improve learnware
body:
- type: textarea
id: system-info
id: bug-detail
attributes:
label: System Info
description: Please share your system info with us.
placeholder: learnware version, platform, python version, ...
label: Bug Detail
description: Please report the bug in detail or provide a code sample that reproduces the problem you ran into.
placeholder: bug detail and reproduction.
validations:
required: true
- type: textarea
id: reproduction
validations:
required: true
id: runtime-environment
attributes:
label: Reproduction
description: |
Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
If you have code snippets, error messages, stack traces please provide them here as well.
Important! Use code tags to correctly format your code. See [Github Guidelines about Code Blocks](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting).
Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
placeholder: |
Steps to reproduce the behavior:
1.
2.
3.
- type: textarea
id: expected-behavior
label: Runtime Environment
description: Please share your environment setting with us.
placeholder: learnware version, platform, python version, ...
validations:
required: true
attributes:
label: Expected behavior
description: "A clear and concise description of what you would expect to happen."
required: true

+ 3
- 11
.github/ISSUE_TEMPLATE/feature-request.yml View File

@@ -9,22 +9,14 @@ body:
attributes:
label: Feature request
description: |
A clear and concise description of the feature proposal. Please provide a link to the paper and code in case they exist.
A clear and concise description of the feature proposal. If this is related to papers, codes, or other issues, please link here.
- type: textarea
id: motivation
validations:
required: true
attributes:
label: Motivation
description: |
Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too.
- type: textarea
id: contribution
validations:
required: true
attributes:
label: Your contribution
label: Your Contribution
description: |
Is there any way that you could help, e.g. by submitting a PR? Make sure to read the [developer guide](https://github.com/Learnware-LAMDA/Learnware/blob/main/docs/about/dev.rst).
Is there any way that you could help, e.g. by submitting a PR?

Loading…
Cancel
Save