未验证 提交 6f581cc7 编写于 作者: W wangguanzhong 提交者: GitHub

[cherry-pick] update issue template (#5958)

* update issue template, test=document_fix

* update template, test=document_fix

* add chinese label, test=document_fix
上级 bb3afbfc
---
name: "\U0001F516 其他通用问题 / Other General Issues"
about: 提出其他问题 / Suggest other general issues
title: "[Other General Issues]"
labels: ''
assignees: ''
---
**PaddleDetection team appreciate any suggestion or problem you delivered~**
## Checklist:
1. 查找历史相关issue寻求解答/I have searched related issues but cannot get the expected help.
2. 翻阅[FAQ](https://paddledetection.readthedocs.io/FAQ.html) /I have read the [FAQ documentation](https://paddledetection.readthedocs.io/FAQ.html) but cannot get the expected help.
## 描述问题/Describe the bug
A clear and concise description of what the bug is.
## 复现/Reproduction
1. 您使用的命令是?/What command or script did you run?
```none
请填写命令/A placeholder for the command.
```
2. 您是否更改过代码或配置文件?您是否理解您所更改的内容?还请您提供所更改的部分代码。/Did you make any modifications on the code or config? Did you understand what you have modified? Please provide the codes that you modified.
3. 您使用的数据集是?/What dataset did you use?
4. 请提供您出现的报错信息及相关log。/Please provide the error messages or relevant log information.
## 环境/Environment
1. 请提供您使用的Paddle和PaddleDetection的版本号/Please provide the version of Paddle and PaddleDetection you use:
2. 如您在使用PaddleDetection的同时还在使用其他产品,如PaddleServing、PaddleInference等,请您提供其版本号/ Please provide the version of any other related tools/products used, such as the version of PaddleServing and etc:
3. 请提供您使用的操作系统信息,如Linux/Windows/MacOS /Please provide the OS information, e.g., Linux:
4. 请问您使用的Python版本是?/ Please provide the version of Python you used.
5. 请问您使用的CUDA/cuDNN的版本号是?/ Please provide the version of CUDA/cuDNN you used.
如果您的issue是关于安装或环境,您可以先查询[安装文档](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL_cn.md)尝试解决~
If your issue looks like an installation issue / environment issue,
please first try to solve it yourself with the instructions in
https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL.md
---
name: "\U0001F680 新功能需求 / Feature Request"
about: 提出一个新的功能需求或改进建议 / Suggest an improvement for PaddleDetection
title: "[Feature Request]"
labels: ''
assignees: ''
---
## 🚀 新功能/Feature
PaddleDetection欢迎大家以清晰简洁的语言提出新功能需求。
A clear and concise description of the feature proposal.
## 需求原因&示例/Motivation & Examples
请描述这个需求的必要性。
Tell us why the feature is useful.
请描述这个需求可实现的具体功能,如果可以,辛苦您提供相关代码实现效果。
Describe what the feature would look like, if it is implemented.
Best demonstrated using **code examples** in addition to words.
## 📣 注意/Note
PaddleDetection仅添加通用性较高的新功能/特性。
We only consider adding new features if they are relevant to many users.
如果您需要论文中的模型能力,PaddleDetection会优先考虑与目标检测强相关且意义较大的论文。
If you request implementation of research papers -- we only consider papers that have enough significance and prevalence in the object detection field.
比如“让XX功能更快”类似的需求不能作为一个有效需求,需要更具体的描述,如“创建一个具体XX工具/功能,让XX更快”即是一个有效需求。
"Make X faster/accurate" is not a valid feature request. "Implement a concrete feature that can make X faster/accurate" can be a valid feature request.
PaddleDetection感谢您的支持,我们期待您提出新功能需求!
Thanks for your suggestions!
---
name: "\U0001F4D6 文档优化 / Documentation Improvement"
about: 对现有的文档教程提出修改建议 / Suggest an improvement about existing documentation or tutorials
in PaddleDetection.
title: "[Document Improvement]"
labels: ''
assignees: ''
---
## 📖 文档优化/Documentation Improvement
**请简单说明文档存在问题/Please provide a concise and brief description of the documentation problem:**
**请提供有问题的文档部分截图及链接/Please provide the screen shoot and the link of the document:**
---
name: "\U0001F41B 提出Bug / Bug Report"
about: 提出PaddleDetection使用中存在的Bug / Report a bug in PaddleDetection
title: "[BUG]"
labels: ''
assignees: ''
---
**PaddleDetection team appreciate any suggestion or problem you delivered~**
## Checklist:
1. 查找历史相关issue寻求解答/I have searched related issues but cannot get the expected help.
2. 翻阅[FAQ](https://paddledetection.readthedocs.io/FAQ.html) /I have read the [FAQ documentation](https://paddledetection.readthedocs.io/FAQ.html) but cannot get the expected help.
3. 确认bug是否在新版本里还未修复/The bug has not been fixed in the latest version.
## 描述问题/Describe the bug
A clear and concise description of what the bug is.
## 复现/Reproduction
1. 您使用的命令是?/What command or script did you run?
```none
请填写命令/A placeholder for the command.
```
2. 您是否更改过代码或配置文件?您是否理解您所更改的内容?还请您提供所更改的部分代码。/Did you make any modifications on the code or config? Did you understand what you have modified? Please provide the codes that you modified.
3. 您使用的数据集是?/What dataset did you use?
4. 请提供您出现的报错信息及相关log。/Please provide the error messages or relevant log information.
## 环境/Environment
1. 请提供您使用的Paddle和PaddleDetection的版本号/Please provide the version of Paddle and PaddleDetection you use:
2. 如您在使用PaddleDetection的同时还在使用其他产品,如PaddleServing、PaddleInference等,请您提供其版本号/ Please provide the version of any other related tools/products used, such as the version of PaddleServing and etc:
3. 请提供您使用的操作系统信息,如Linux/Windows/MacOS /Please provide the OS information, e.g., Linux:
4. 请问您使用的Python版本是?/ Please provide the version of Python you used.
5. 请问您使用的CUDA/cuDNN的版本号是?/ Please provide the version of CUDA/cuDNN you used.
如果您的issue是关于安装或环境,您可以先查询[安装文档](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL_cn.md)尝试解决~
If your issue looks like an installation issue / environment issue,
please first try to solve it yourself with the instructions in
https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.1/docs/tutorials/INSTALL.md
name: 🐛 报BUG Bug Report
description: 报告一个可复现的BUG帮助我们修复PaddleDetection。 Report a bug to help us reproduce and fix it.
labels: [type/bug-report, status/new-issue]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a PaddleDetection Bug Report!
- type: checkboxes
attributes:
label: 问题确认 Search before asking
description: >
在向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).
options:
- 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.
required: true
- type: textarea
id: code
attributes:
label: bug描述 Describe the Bug
description: |
请清晰简洁的描述这个bug,最好附上bug复现步骤及最小代码集,以便我们可以通过运行代码来重现错误。代码片段需要尽可能简洁,请花些时间去掉不相关的代码以帮助我们有效地调试。我们希望通过复制代码并运行得到与你相同的结果,请避免任何外部数据或包含相关的导入等。如果代码太长,请将可执行代码放到[AIStudio](https://aistudio.baidu.com/aistudio/index)中并将项目设置为公开(或者放到github gist上),请在项目中描述清楚bug复现步骤,在issue中描述期望结果与实际结果。
如果你报告的是一个报错信息,请将完整回溯的报错贴在这里,并使用 ` ```三引号块``` `展示错误信息。
placeholder: |
请清晰简洁的描述这个bug。A clear and concise description of what the bug is.
```python
# 最小可复现代码。 Sample code to reproduce the problem.
```
```shell
带有完整回溯的报错信息。 The error message you got, with the full traceback.
```
validations:
required: true
- type: textarea
attributes:
label: 复现环境 Environment
description: 请具体说明复现bug的环境信息,Please specify the software and hardware you used to produce the bug.
placeholder: |
- PaddlePaddle: 2.2.2
- PaddleDetection: release/2.4
- Python: 3.8.0
- CUDA: 10.2
- CUDNN: 7.6
validations:
required: false
- type: checkboxes
attributes:
label: 是否愿意提交PR Are you willing to submit a PR?
description: >
(可选)如果你对修复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.
options:
- label: Yes I'd like to help by submitting a PR!
- type: markdown
attributes:
value: >
感谢你的贡献 🎉!Thanks for your contribution 🎉!
name: 🚀 新需求 Feature Request
description: 提交一个你对PaddleDetection的新需求。 Submit a request for a new Paddle feature.
labels: [type/feature-request, status/new-issue]
body:
- type: markdown
attributes:
value: >
#### 你可以在这里提出你对PaddleDetection的新需求,包括但不限于:功能或模型缺失、功能不全或无法使用、精度/性能不符合预期等。
#### You could submit a request for a new feature here, including but not limited to: new features or models, incomplete or unusable features, accuracy/performance not as expected, etc.
- type: checkboxes
attributes:
label: 问题确认 Search before asking
description: >
在向PaddleDetection提新需求之前,请先查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)是否报过同样的需求。
Before submitting a feature request, 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:
- label: >
我已经查询[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues),没有类似需求。I have searched the [issues](https://github.com/PaddlePaddle/PaddleDetection/issues) and found no similar feature requests.
required: true
- type: textarea
id: description
attributes:
label: 需求描述 Feature Description
description: |
请尽可能包含任务目标、需求场景、功能描述等信息,全面的信息有利于我们准确评估你的需求。
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.
value: "1. 任务目标(请描述你正在做的项目是什么,如模型、论文、项目是什么?); 2. 需求场景(请描述你的项目中为什么需要用此功能); 3. 功能描述(请简单描述或设计这个功能)"
validations:
required: true
- type: checkboxes
attributes:
label: 是否愿意提交PR Are you willing to submit a PR?
description: >
(可选)如果你对新feature有自己的想法,十分鼓励提交[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.
options:
- label: Yes I'd like to help by submitting a PR!
- type: markdown
attributes:
value: >
感谢你的贡献 🎉!Thanks for your contribution 🎉!
name: 📚 文档 Documentation Issue
description: 反馈一个官网文档错误。 Report an issue related to https://github.com/PaddlePaddle/PaddleDetection.
labels: [type/docs, status/new-issue]
body:
- type: markdown
attributes:
value: >
#### 请确认反馈的问题来自PaddlePaddle官网文档:https://github.com/PaddlePaddle/PaddleDetection 。
#### Before submitting a Documentation Issue, Please make sure that issue is related to https://github.com/PaddlePaddle/PaddleDetection.
- type: textarea
id: link
attributes:
label: 文档链接&描述 Document Links & Description
description: |
请说明有问题的文档链接以及该文档存在的问题。
Please fill in the link to the document and describe the question.
validations:
required: true
- type: textarea
id: error
attributes:
label: 请提出你的建议 Please give your suggestion
description: |
请告诉我们,你希望如何改进这个文档。或者你可以提个PR修复这个问题。
Please tell us how you would like to improve this document. Or you can submit a PR to fix this problem.
validations:
required: false
- type: markdown
attributes:
value: >
感谢你的贡献 🎉!Thanks for your contribution 🎉!
name: 🙋🏼‍♀️🙋🏻‍♂️提问 Ask a Question
description: 提出一个使用/咨询问题。 Ask a usage or consultation question.
labels: [type/question, status/new-issue]
body:
- type: checkboxes
attributes:
label: 问题确认 Search before asking
description: >
#### 你可以在这里提出一个使用/咨询问题,提问之前请确保:
- 1)已经百度/谷歌搜索过你的问题,但是没有找到解答;
- 2)已经在官网查询过[教程文档](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.4/docs/tutorials/GETTING_STARTED_cn.md)与[FAQ](https://github.com/PaddlePaddle/PaddleDetection/tree/release/2.4/docs/tutorials/FAQ),但是没有找到解答;
- 3)已经在[历史issue](https://github.com/PaddlePaddle/PaddleDetection/issues)中搜索过,没有找到同类issue或issue未被解答。
#### You could ask a usage or consultation question here, before your start, please make sure:
- 1) You have searched your question on Baidu/Google, but found no answer;
- 2) You have checked the [tutorials](https://github.com/PaddlePaddle/PaddleDetection/blob/release/2.4/docs/tutorials/GETTING_STARTED.md), but found no answer;
- 3) You have searched [the existing and past issues](https://github.com/PaddlePaddle/PaddleDetection/issues), but found no similar issue or the issue has not been answered.
options:
- label: >
我已经搜索过问题,但是没有找到解答。I have searched the question and found no related answer.
required: true
- type: textarea
id: question
attributes:
label: 请提出你的问题 Please ask your question
validations:
required: true
name: 🧩 其他 Others
description: 提出其他问题。 Report any other non-support related issues.
labels: [type/others, status/new-issue]
body:
- type: markdown
attributes:
value: >
#### 你可以在这里提出任何前面几类模板不适用的问题,包括但不限于:优化性建议、框架使用体验反馈、版本兼容性问题、报错信息不清楚等。
#### 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.
- type: textarea
id: others
attributes:
label: 问题描述 Please describe your issue
validations:
required: true
- type: markdown
attributes:
value: >
感谢你的贡献 🎉! Thanks for your contribution 🎉!
......@@ -385,6 +385,7 @@
- 感谢[Chen-Song](https://github.com/Chen-Song)贡献`Swin Faster-RCNN`模型。
- 感谢[yangyudong](https://github.com/yangyudong2020), [hchhtc123](https://github.com/hchhtc123) 开发PP-Tracking GUI界面
- 感谢[Shigure19](https://github.com/Shigure19) 开发PP-TinyPose健身APP
- 感谢[manangoel99](https://github.com/manangoel99)贡献Wandb可视化方式
## <img src="https://user-images.githubusercontent.com/48054808/157835276-9aab9d1c-1c46-446b-bdd4-5ab75c5cfa48.png" width="20"/> 引用
......
......@@ -360,6 +360,7 @@ Contributions are highly welcomed and we would really appreciate your feedback!!
- Thanks [Chen-Song](https://github.com/Chen-Song) for contributing the code of `Swin Faster-RCNN` model.
- Thanks [yangyudong](https://github.com/yangyudong2020), [hchhtc123](https://github.com/hchhtc123) for contributing PP-Tracking GUI interface.
- Thanks [Shigure19](https://github.com/Shigure19) for contributing PP-TinyPose fitness APP.
- Thanks [manangoel99](https://github.com/manangoel99) for contributing Wandblogger for visualization of the training and evaluation metrics
## <img src="https://user-images.githubusercontent.com/48054808/157835276-9aab9d1c-1c46-446b-bdd4-5ab75c5cfa48.png" width="20"/> Citation
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册