Skip to content

Commit 610dae2

Browse files
HydrogenSulfateHydrogenSulfate
authored
Merge pull request #347 from HydrogenSulfate/add_issue_temp
update issue template
2 parents bbc1f77 + b74052e commit 610dae2

File tree

6 files changed

+259
-0
lines changed

6 files changed

+259
-0
lines changed

‎.github/ISSUE_TEMPLATE/1_bug-report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: 🐛 BUG报告 Bug Report
2+
description: 报告一个可复现的BUG帮助我们修复套件。 Report a bug to help us reproduce and fix it.
3+
labels: [type/bug-report, status/new-issue]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 在向 PaddleScience 报bug之前，请先查询 [历史issue](https://github.com/PaddlePaddle/PaddleScience/issues) 是否报过同样的bug。
10+
11+
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/PaddlePaddle/PaddleScience/issues).
12+
13+
- type: textarea
14+
id: code
15+
attributes:
16+
label: bug 描述 bug description
17+
description: |
18+
请清晰简洁的描述这个bug，最好附上bug复现环境、bug复现步骤及最小代码集，以便我们可以通过运行代码来重现错误。代码片段需要尽可能简洁，请花些时间去掉不相关的代码以帮助我们有效地调试。我们希望通过复制代码并运行得到与你相同的结果，请避免任何外部数据或包含相关的导入等。例如：
19+
```python
20+
# 导入所有必要的库。 All necessary imports at the beginning.
21+
import paddle
22+
23+
# 一个简洁的片段，能够定位到bug。 A succinct reproducing example trimmed down to the essential parts.
24+
a = paddle.rand(shape=[1,4])
25+
b = paddle.rand(shape=[1,4])
26+
a.stop_gradient = False
27+
b.stop_gradient = False
28+
29+
c = paddle.zeros((4, 4))
30+
c[0, :] = a/b
31+
32+
print('Is c requires grad: ', not c.stop_gradient) # 注意：这里出现了bug，期望requires_grad=True
33+
```
34+
如果代码太长，请将可执行代码放到 [AIStudio](https://aistudio.baidu.com/aistudio/index) 中并将项目设置为公开（或者放到github 或 gist上），请在项目中描述清楚bug复现步骤，在issue中描述期望结果与实际结果。
35+
如果你报告的是一个报错信息，请将完整回溯的报错贴在这里，并使用 ` ```三引号块``` `展示错误信息。
36+
37+
placeholder: |
38+
请清晰简洁的描述这个bug。A clear and concise description of what the bug is.
39+
40+
```python
41+
# 最小可复现代码。 Sample code to reproduce the problem.
42+
```
43+
44+
```shell
45+
带有完整回溯的报错信息。 The error message you got, with the full traceback.
46+
```
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: others
52+
attributes:
53+
label: 其他补充信息 Additional Supplementary Information
54+
description: |
55+
如果你还有其他需要补充的内容，请写在这里。
56+
If you have anything else to add, please write it here.
57+
validations:
58+
required: false
59+
60+
- type: markdown
61+
attributes:
62+
value: >
63+
感谢你的贡献 🎉！Thanks for your contribution 🎉!

‎.github/ISSUE_TEMPLATE/2_feature-request.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 🚀 新需求 Feature Request
2+
description: 提交一个你对 PaddleScience 的新需求。 Submit a request for a new PaddleScience feature.
3+
labels: [type/feature-request, status/new-issue]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 你可以在这里提出你对 PaddleScience 的新需求，包括但不限于：功能或模型缺失、功能不全或无法使用、精度/性能不符合预期等。
10+
11+
#### You could submit a request for a new PaddleScience feature here, including but not limited to: new features or models, incomplete or unusable features, accuracy/performance not as expected, etc.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: 需求描述 Feature Description
17+
description: |
18+
请尽可能包含任务目标、需求场景、功能描述等信息，全面的信息有利于我们准确评估你的需求。
19+
Please include as much information as possible, such as mission objectives, requirement scenarios, functional descriptions, etc. Comprehensive information will help us accurately assess your feature request.
20+
value: "任务目标（请描述你正在做的项目是什么，如模型、论文、项目是什么？）; <br /> 需求场景（请描述你的项目中为什么需要用此功能）; <br /> 功能描述（请简单描述或设计这个功能）"
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: 替代实现 Alternatives
28+
description: |
29+
如果你考虑过的任何替代解决方案或功能，请简要描述下，我们会综合评估。
30+
A description of any alternative solutions or features you've considered, if any.
31+
validations:
32+
required: false
33+
34+
- type: markdown
35+
attributes:
36+
value: >
37+
感谢你的贡献 🎉！Thanks for your contribution 🎉!

‎.github/ISSUE_TEMPLATE/3_build-installation-issue.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: 🗂 安装 Build/Installation Issue
2+
description: 报告一个安装问题。 Report an issue related to build or install Paddle.
3+
labels: [type/build, status/new-issue]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 安装请参考 [安装使用](https://paddlescience-docs.readthedocs.io/zh/latest/zh/install_setup/)，若未能解决你的问题，你可以在这里提 issue。
10+
11+
#### Before submitting a Build/Installation Issue, please make sure you have visited the [install_setup](https://paddlescience-docs.readthedocs.io/zh/latest/zh/install_setup/).
12+
13+
- type: textarea
14+
id: error
15+
attributes:
16+
label: 问题描述 Issue Description
17+
description: |
18+
请详细描述你的问题，同步贴出报错信息、日志/代码关键片段、复现步骤，以便我们快速排查问题。
19+
Please describe your problem in detail, and synchronously post the error message, key log/code snippet, and reproduction steps, so that we can quickly troubleshoot the problem.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: environment
25+
attributes:
26+
label: 版本&环境信息 Version & Environment Information
27+
description: |
28+
请参考以下命令运行脚本 [summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取版本和环境信息，并将输出拷贝在这里。
29+
Please run the following and paste the output below.
30+
```shell
31+
wget https://raw.githubusercontent.com/PaddlePaddle/Paddle/develop/tools/summary_env.py
32+
python3 -m pip install distro
33+
python3 summary_env.py
34+
```
35+
若运行脚本出现问题，请在issue中说明，并提供以下信息：
36+
1. PaddlePaddle版本：请提供你的PaddlePaddle版本号（如2.0.0）或CommitID。
37+
2. CPU（可选）：请提供CPU型号，MKL/OpenBlas/MKLDNN/等数学库的使用情况，是否支持AVX指令集。
38+
3. GPU：请提供GPU型号，CUDA（如cuda10.2）和CUDNN版本号（如cudnn7.6.5）。
39+
4. 系统环境：请说明系统类型、版本（如Mac OS 10.14）。
40+
5. Python版本（如python 3.7）。
41+
6. （可选）若安装过程遇到问题，请提供安装方式（pip/conda/docker/源码编译）和相应的安装命令。
42+
7. （可选）若使用paddle过程中，遇到了无法使用gpu相关问题，请在命令行中键入`nvidia-smi`和`nvcc -V`，提供这两个命令输出的截图。
43+
8. （可选）若使用特殊硬件，请单独注明。
44+
45+
placeholder: |
46+
****************************************
47+
Paddle version:
48+
Paddle With CUDA:
49+
50+
OS:
51+
GCC version:
52+
Clang version:
53+
CMake version:
54+
Libc version:
55+
Python version:
56+
57+
CUDA version:
58+
cuDNN version:
59+
Nvidia driver version:
60+
Nvidia driver List:
61+
****************************************
62+
validations:
63+
required: true
64+
65+
- type: markdown
66+
attributes:
67+
value: >
68+
感谢你的贡献 🎉！Thanks for your contribution 🎉!

‎.github/ISSUE_TEMPLATE/4_documentation-issue.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 📚 文档 Documentation Issue
2+
description: 反馈一个官网文档错误。 Report an issue related to https://paddlescience-docs.readthedocs.io/zh/latest/.
3+
labels: [type/docs, status/new-issue]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 请确认反馈的问题来自 PaddleScience 官网文档：https://paddlescience-docs.readthedocs.io/zh/latest/ 。
10+
11+
#### Before submitting a Documentation Issue, Please make sure that issue is related to https://paddlescience-docs.readthedocs.io/zh/latest/.
12+
13+
- type: textarea
14+
id: link
15+
attributes:
16+
label: 文档链接&描述 Document Links&Description
17+
description: |
18+
请说明有问题的文档链接以及该文档存在的问题。
19+
Please fill in the link to the document and describe the question.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: error
25+
attributes:
26+
label: 请提出你的建议 Please give your suggestion
27+
description: |
28+
请告诉我们，你希望如何改进这个文档。或者你可以提个PR修复这个问题。
29+
Please tell us how you would like to improve this document. Or you can submit a PR to fix this problem.
30+
31+
validations:
32+
required: false
33+
34+
- type: markdown
35+
attributes:
36+
value: >
37+
感谢你的贡献 🎉！Thanks for your contribution 🎉!

‎.github/ISSUE_TEMPLATE/5_ask-a-question.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🙋🏼‍♀️🙋🏻‍♂️提问 Ask a Question
2+
description: 提出一个使用/咨询问题。 Ask a usage or consultation question.
3+
labels: [type/question, status/new-issue]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 你可以在这里提出一个使用/咨询问题，提问之前请确保：
10+
11+
- 1）已经百度/谷歌搜索过你的问题，但是没有找到解答；
12+
13+
- 2）已经在官网查询过 [API文档](https://paddlescience-docs.readthedocs.io/zh/latest/zh/api/arch/)，但是没有找到解答；
14+
15+
- 3）已经在[历史issue](https://github.com/PaddlePaddle/PaddleScience/issues)中搜索过，没有找到同类issue或issue未被解答。
16+
17+
18+
#### You could ask a usage or consultation question here, before your start, please make sure:
19+
20+
- 1) You have searched your question on Baidu/Google, but found no answer;
21+
22+
- 2) You have checked the [API documentation](https://paddlescience-docs.readthedocs.io/zh/latest/zh/api/arch/), but found no answer;
23+
24+
- 3) You have searched [the existing and past issues](https://github.com/PaddlePaddle/PaddleScience/issues), but found no similar issue or the issue has not been answered.
25+
26+
- type: textarea
27+
id: question
28+
attributes:
29+
label: 请提出你的问题 Please ask your question
30+
validations:
31+
required: true

‎.github/ISSUE_TEMPLATE/6_others.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: 🧩 其他 Others
2+
description: 提出其他问题。 Report any other non-support related issues.
3+
labels: [type/others, status/new-issue]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 你可以在这里提出任何前面几类模板不适用的问题，包括但不限于：优化性建议、框架使用体验反馈、版本兼容性问题、报错信息不清楚等。
10+
11+
#### You can report any issues that are not applicable to the previous types of templates, including but not limited to: enhancement suggestions, feedback on the use of the framework, version compatibility issues, unclear error information, etc.
12+
13+
- type: textarea
14+
id: others
15+
attributes:
16+
label: 问题描述 Please describe your issue
17+
validations:
18+
required: true
19+
20+
- type: markdown
21+
attributes:
22+
value: >
23+
感谢你的贡献 🎉！ Thanks for your contribution 🎉!

0 commit comments

Comments
 (0)