未验证 提交 0a02ef4e 编写于 作者: F Feng Ni 提交者: GitHub

update issue bug template (#6845)

* update issue bug template, test=document_fix

* update issue bug template, test=document_fix
上级 8679e93c
name: 🐛 报BUG Bug Report name: 🐛 报BUG Bug Report
description: 报告一个可复现的BUG帮助我们修复PaddleDetection。 Report a bug to help us reproduce and fix it. description: 报告一个可复现的Bug以帮助我们修复PaddleDetection。 Report a bug to help us reproduce and fix it.
labels: [type/bug-report, status/new-issue] labels: [type/bug-report, status/new-issue]
body: body:
...@@ -12,34 +12,52 @@ body: ...@@ -12,34 +12,52 @@ body:
attributes: attributes:
label: 问题确认 Search before asking label: 问题确认 Search before asking
description: > description: >
在向PaddleDetection报bug之前,请先查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)是否报过同样的bug。 (必选项) 在向PaddleDetection报bug之前,请先查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)是否报过同样的bug。
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/PaddleDetection/issues). (Required) 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/PaddleDetection/issues).
options: options:
- label: > - label: >
我已经查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues),没有报过同样bug。I have searched the [issues](https://github.com/PaddlePaddle/PaddleDetection/issues) and found no similar bug report. 我已经查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues),没有发现相似的bug。I have searched the [issues](https://github.com/PaddlePaddle/PaddleDetection/issues) and found no similar bug report.
required: true required: true
- type: dropdown
attributes:
label: Bug组件 Bug Component
description: |
(可选项) 请选择在哪部分代码发现这个bug。(Optional) Please select the part of PaddleDetection where you found the bug.
multiple: true
options:
- "Training"
- "Validation"
- "Inference"
- "Export"
- "Deploy"
- "Installation"
- "DataProcess"
- "Other"
validations:
required: false
- type: textarea - type: textarea
id: code id: code
attributes: attributes:
label: bug描述 Describe the Bug label: Bug描述 Describe the Bug
description: | description: |
请清晰简洁的描述这个bug,最好附上bug复现步骤及最小代码集,以便我们可以通过运行代码来重现错误。代码片段需要尽可能简洁,请花些时间去掉不相关的代码以帮助我们有效地调试。我们希望通过复制代码并运行得到与你相同的结果,请避免任何外部数据或包含相关的导入等。如果代码太长,请将可执行代码放到[AIStudio](https://aistudio.baidu.com/aistudio/index)中并将项目设置为公开(或者放到github gist上),请在项目中描述清楚bug复现步骤,在issue中描述期望结果与实际结果。 请清晰而简洁地描述这个bug,并附上bug复现步骤、报错信息或截图、代码改动说明或最小可复现代码。如果代码太长,请将可执行代码放到[AIStudio](https://aistudio.baidu.com/aistudio/index)中并将项目设置为公开(或者放到github gist上),并在项目中描述清楚bug复现步骤,在issue中描述期望结果与实际结果。
如果你报告的是一个报错信息,请将完整回溯的报错贴在这里,并使用 ` ```三引号块``` `展示错误信息。 如果你报告的是一个报错信息,请将完整回溯的报错贴在这里,并使用 ` ```三引号块``` `展示错误信息。
placeholder: | placeholder: |
请清晰简洁的描述这个bug。A clear and concise description of what the bug is. 请清晰简洁的描述这个bug。 A clear and concise description of what the bug is.
```python ```python
# 最小可复现代码。 Sample code to reproduce the problem. 代码改动说明,或最小可复现代码。 Code change description, or sample code to reproduce the problem.
``` ```
```shell ```shell
带有完整回溯的报错信息。 The error message you got, with the full traceback. 带有完整回溯信息的报错日志或截图。 The error log or screenshot you got, with the full traceback.
``` ```
validations: validations:
required: true required: true
...@@ -47,25 +65,40 @@ body: ...@@ -47,25 +65,40 @@ body:
- type: textarea - type: textarea
attributes: attributes:
label: 复现环境 Environment label: 复现环境 Environment
description: 请具体说明复现bug的环境信息,Please specify the software and hardware you used to produce the bug. description: 请具体说明复现bug的环境信息。Please specify the environment information for reproducing the bug.
placeholder: | placeholder: |
- OS: Linux/Windows
- PaddlePaddle: 2.2.2 - PaddlePaddle: 2.2.2
- PaddleDetection: release/2.4 - PaddleDetection: release/2.4
- Python: 3.8.0 - Python: 3.8.0
- CUDA: 10.2 - CUDA: 10.2
- CUDNN: 7.6 - CUDNN: 7.6
- GCC: 8.2.0
validations: validations:
required: false required: true
- type: checkboxes
attributes:
label: Bug描述确认 Bug description confirmation
description: >
(必选项) 请确认是否提供了详细的Bug描述和环境信息,确认问题是否可以复现。
(Required) Please confirm whether the bug description and environment information are provided, and whether the problem can be reproduced.
options:
- label: >
我确认已经提供了Bug复现步骤、代码改动说明、以及环境信息,确认问题是可以复现的。I confirm that the bug replication steps, code change instructions, and environment information have been provided, and the problem can be reproduced.
required: true
- type: checkboxes - type: checkboxes
attributes: attributes:
label: 是否愿意提交PR Are you willing to submit a PR? label: 是否愿意提交PR Are you willing to submit a PR?
description: > description: >
(可选)如果你对修复bug有自己的想法,十分鼓励提交[Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls),共同提升PaddleDetection (可选项) 如果你对修复bug有自己的想法,十分鼓励提交[Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls),共同提升PaddleDetection。
(Optional) We encourage you to submit a [Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls) (PR) to help improve PaddleDetection for everyone, especially if you have a good understanding of how to implement a fix or feature. (Optional) We encourage you to submit a [Pull Request](https://github.com/PaddlePaddle/PaddleDetection/pulls) (PR) to help improve PaddleDetection for everyone, especially if you have a good understanding of how to implement a fix or feature.
options: options:
- label: Yes I'd like to help by submitting a PR! - label: 我愿意提交PR!I'd like to help by submitting a PR!
- type: markdown - type: markdown
attributes: attributes:
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册