[Feature] Update the issue template with more links and emoji. (#1032)
* [Feature] update the issue template with more links and emoji * fix lint error * Use yaml format issue templates. * Update template Co-authored-by: mzr1996 <mzr1996@163.com>pull/952/merge
Songyang Zhang
GitHub
parent
75ae8453ac
commit
c94e9b3669
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
name: 寻求帮助
|
||||
about: 遇到问题并寻求帮助
|
||||
title: ''
|
||||
labels: help wanted
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
推荐使用英语模板 General question，以便你的问题帮助更多人。
|
||||
|
||||
### 首先确认以下内容
|
||||
|
||||
- 我已经查询了相关的 issue，但没有找到需要的帮助。
|
||||
- 我已经阅读了相关文档，但仍不知道如何解决。
|
||||
|
||||
### 描述你遇到的问题
|
||||
|
||||
\[填写这里\]
|
||||
|
||||
### 相关信息
|
||||
|
||||
1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出
|
||||
\[填写这里\]
|
||||
2. 如果你修改了，或者使用了新的配置文件，请在这里写明
|
||||
|
||||
```python
|
||||
[填写这里]
|
||||
```
|
||||
|
||||
3. 如果你是在训练过程中遇到的问题，请填写完整的训练日志和报错信息
|
||||
\[填写这里\]
|
||||
4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改，请在这里写明
|
||||
\[填写这里\]
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
---
|
||||
name: 新功能
|
||||
about: 为项目提一个建议
|
||||
title: '[Feature]'
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
推荐使用英语模板 Feature request，以便你的问题帮助更多人。
|
||||
|
||||
### 描述这个功能
|
||||
|
||||
\[填写这里\]
|
||||
|
||||
### 动机
|
||||
|
||||
请简要说明以下为什么需要添加这个新功能
|
||||
例 1. 现在进行 xxx 的时候不方便
|
||||
例 2. 最近的论文中提出了有一个很有帮助的 xx
|
||||
|
||||
\[填写这里\]
|
||||
|
||||
### 相关资源
|
||||
|
||||
是否有相关的官方实现或者第三方实现？这些会很有参考意义。
|
||||
|
||||
\[填写这里\]
|
||||
|
||||
### 其他相关信息
|
||||
|
||||
其他和这个功能相关的信息或者截图，请放在这里。
|
||||
另外如果你愿意参与实现这个功能并提交 PR，请在这里说明，我们将非常欢迎。
|
||||
|
||||
\[填写这里\]
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
---
|
||||
name: 报告 Bug
|
||||
about: 报告问题以帮助我们提升
|
||||
title: '[Bug]'
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
推荐使用英语模板 Bug report，以便你的问题帮助更多人。
|
||||
|
||||
### 描述 bug
|
||||
|
||||
简单地描述一下遇到了什么 bug
|
||||
|
||||
\[填写这里\]
|
||||
|
||||
### 复现流程
|
||||
|
||||
在命令行中执行的详细操作
|
||||
|
||||
```shell
|
||||
[填写这里]
|
||||
```
|
||||
|
||||
### 相关信息
|
||||
|
||||
1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出
|
||||
\[填写这里\]
|
||||
2. 如果你修改了，或者使用了新的配置文件，请在这里写明
|
||||
|
||||
```python
|
||||
[填写这里]
|
||||
```
|
||||
|
||||
3. 如果你是在训练过程中遇到的问题，请填写完整的训练日志和报错信息
|
||||
\[填写这里\]
|
||||
4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改，请在这里写明
|
||||
\[填写这里\]
|
||||
|
||||
### 附加内容
|
||||
|
||||
任何其他有关该 bug 的信息、截图等
|
||||
|
||||
\[填写这里\]
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
name: 🐞 Bug report
|
||||
description: Create a report to help us improve
|
||||
labels: ["bug"]
|
||||
title: "[Bug] "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
If you have already identified the reason, we strongly appreciate you creating a new PR according to [the tutorial](https://mmclassification.readthedocs.io/en/master/community/CONTRIBUTING.html)!
|
||||
If you need our help, please fill in the following form to help us to identify the bug.
|
||||
|
||||
- type: textarea
|
||||
id: describe
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: |
|
||||
Please provide a clear and concise description of what the bug is.
|
||||
Preferably a simple and minimal code snippet that we can reproduce the error by running the code.
|
||||
placeholder: |
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
```python
|
||||
# Sample code to reproduce the problem
|
||||
```
|
||||
|
||||
```shell
|
||||
The command or script you run.
|
||||
```
|
||||
|
||||
```
|
||||
The error message or logs you got, with the full traceback.
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Environment
|
||||
description: |
|
||||
Please run `python -c "import mmcls.utils;import pprint;pprint.pp(dict(mmcls.utils.collect_env()))"` to collect necessary environment information and paste it here.
|
||||
placeholder: |
|
||||
```python
|
||||
# The output the above command
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: Other information
|
||||
description: |
|
||||
Tell us anything else you think we should know.
|
||||
|
||||
1. Did you make any modifications on the code or config?
|
||||
2. What do you think might be the reason?
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
name: 🚀 Feature request
|
||||
description: Suggest an idea for this project
|
||||
labels: ["enhancement"]
|
||||
title: "[Feature] "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
If you have already implemented the feature, we strongly appreciate you creating a new PR according to [the tutorial](https://mmclassification.readthedocs.io/en/master/community/CONTRIBUTING.html)!
|
||||
|
||||
- type: textarea
|
||||
id: describe
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Describe the feature
|
||||
description: |
|
||||
What kind of feature do you want MMClassification to add. If there is an official code release or third-party implementation, please also provide the information here, which would be very helpful.
|
||||
placeholder: |
|
||||
A clear and concise description of the motivation of the feature.
|
||||
Ex1. It is inconvenient when \[....\].
|
||||
Ex2. There is a recent paper \[....\], which is very helpful for \[....\].
|
||||
|
||||
- type: checkboxes
|
||||
id: pr
|
||||
attributes:
|
||||
label: Will you implement it?
|
||||
options:
|
||||
- label: I would like to implement this feature and create a PR!
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
name: 💬 General questions
|
||||
description: Ask general questions to get help
|
||||
labels: ["help wanted"]
|
||||
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: prerequisite
|
||||
attributes:
|
||||
label: Prerequisite
|
||||
options:
|
||||
- label: I have searched related issues but cannot get the expected help.
|
||||
required: true
|
||||
- label: I have read [the documentation](https://mmclassification.readthedocs.io/) and don't know what to do.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: describe
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Describe the question
|
||||
placeholder: |
|
||||
1. I have read the documentation but I still don't know how to use the functionality xxx.
|
||||
2. Other questions.
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
name: 🐞 报告 Bug
|
||||
description: 报告你在使用中遇到的不合预期的情况
|
||||
labels: ["bug"]
|
||||
title: "[Bug] "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
我们推荐使用英语模板 Bug report，以便你的问题帮助更多人。
|
||||
|
||||
如果你已经有了解决方案，我们非常欢迎你直接创建一个新的 PR 来解决这个问题。创建 PR 的流程可以参考[文档](https://mmclassification.readthedocs.io/zh_CN/master/community/CONTRIBUTING.html)。
|
||||
如果你需要我们的帮助，请填写以下内容帮助我们定位 Bug。
|
||||
|
||||
- type: textarea
|
||||
id: describe
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: 描述该错误
|
||||
description: |
|
||||
请简要说明你遇到的错误。如果可以的话，请提供一个简短的代码片段帮助我们复现这一错误。
|
||||
placeholder: |
|
||||
问题的简要说明
|
||||
|
||||
```python
|
||||
# 复现错误的代码片段
|
||||
```
|
||||
|
||||
```shell
|
||||
# 发生错误时你的运行命令
|
||||
```
|
||||
|
||||
```
|
||||
错误信息和日志，请展示全部的错误日志和 traceback
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: 环境信息
|
||||
description: |
|
||||
请运行指令 `python -c "import mmcls.utils;import pprint;pprint.pp(dict(mmcls.utils.collect_env()))"` 来收集必要的环境信息，并贴在下方。
|
||||
placeholder: |
|
||||
```python
|
||||
# 上述命令的输出
|
||||
```
|
||||
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: 其他信息
|
||||
description: |
|
||||
告诉我们其他有价值的信息。
|
||||
|
||||
1. 你是否对代码或配置文件做了任何改动？
|
||||
2. 你认为可能的原因是什么？
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
name: 🚀 功能建议
|
||||
description: 建议一项新的功能
|
||||
labels: ["enhancement"]
|
||||
title: "[Feature] "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
推荐使用英语模板 Feature request，以便你的问题帮助更多人。
|
||||
|
||||
如果你已经实现了该功能，我们非常欢迎你直接创建一个新的 PR 来解决这个问题。创建 PR 的流程可以参考[文档](https://mmclassification.readthedocs.io/zh_CN/master/community/CONTRIBUTING.html)。
|
||||
|
||||
- type: textarea
|
||||
id: describe
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: 描述该功能
|
||||
description: |
|
||||
你希望 MMClassification 添加什么功能？如果存在相关的论文、官方实现或者第三方实现，请同时贴出链接，这将非常有帮助。
|
||||
placeholder: |
|
||||
简要说明该功能，及为什么需要该功能
|
||||
例 1. 现在进行 xxx 的时候不方便
|
||||
例 2. 最近的论文中提出了有一个很有帮助的 xx
|
||||
|
||||
- type: checkboxes
|
||||
id: pr
|
||||
attributes:
|
||||
label: 是否希望自己实现该功能？
|
||||
options:
|
||||
- label: 我希望自己来实现这一功能，并向 MMClassification 贡献代码！
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
name: 💬 寻求帮助
|
||||
description: 其他类型的问题需要帮助
|
||||
labels: ["help wanted"]
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
推荐使用英语模板 General question，以便你的问题帮助更多人。
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisite
|
||||
attributes:
|
||||
label: 我已试图查询该问题
|
||||
options:
|
||||
- label: 我已经查阅了相关 issue，没有找到相关帮助。
|
||||
required: true
|
||||
- label: 我已经查询了[官方文档](https://mmclassification.readthedocs.io/zh_CN/master/)，没有找到相关帮助。
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: describe
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: 描述该问题
|
||||
placeholder: |
|
||||
1. 我阅读了文档，仍不清楚如何使用 xxx 功能。
|
||||
2. 其他问题
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: '[Bug]'
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
### Describe the bug
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
\[here\]
|
||||
|
||||
### To Reproduce
|
||||
|
||||
The command you executed.
|
||||
|
||||
```shell
|
||||
[here]
|
||||
```
|
||||
|
||||
### Post related information
|
||||
|
||||
1. The output of `pip list | grep "mmcv\|mmcls\|^torch"`
|
||||
\[here\]
|
||||
2. Your config file if you modified it or created a new one.
|
||||
|
||||
```python
|
||||
[here]
|
||||
```
|
||||
|
||||
3. Your train log file if you meet the problem during training.
|
||||
\[here\]
|
||||
4. Other code you modified in the `mmcls` folder.
|
||||
\[here\]
|
||||
|
||||
### Additional context
|
||||
|
||||
Add any other context about the problem here.
|
||||
|
||||
\[here\]
|
||||
|
|
@ -1,6 +1,12 @@
|
|||
blank_issues_enabled: false
|
||||
|
||||
contact_links:
|
||||
- name: MMClassification Documentation
|
||||
- name: 📚 MMClassification Documentation
|
||||
url: https://mmclassification.readthedocs.io/en/latest/
|
||||
about: Check if your question is answered in docs
|
||||
- name: 💬 Forum
|
||||
url: https://github.com/open-mmlab/mmclassification/discussions
|
||||
about: Ask general usage questions and discuss with other MMClassification community members
|
||||
- name: 🌐 Explore OpenMMLab
|
||||
url: https://openmmlab.com/
|
||||
about: Get know more about OpenMMLab
|
||||
|
|
|
|||
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: '[Feature]'
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
### Describe the feature
|
||||
|
||||
\[here\]
|
||||
|
||||
### Motivation
|
||||
|
||||
A clear and concise description of the motivation of the feature.
|
||||
Ex1. It is inconvenient when \[....\].
|
||||
Ex2. There is a recent paper \[....\], which is very helpful for \[....\].
|
||||
|
||||
\[here\]
|
||||
|
||||
### Related resources
|
||||
|
||||
If there is an official code release or third-party implementation, please also provide the information here, which would be very helpful.
|
||||
|
||||
\[here\]
|
||||
|
||||
### Additional context
|
||||
|
||||
Add any other context or screenshots about the feature request here.
|
||||
If you would like to implement the feature and create a PR, please leave a comment here and that would be much appreciated.
|
||||
|
||||
\[here\]
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
name: General questions
|
||||
about: 'Ask general questions to get help '
|
||||
title: ''
|
||||
labels: help wanted
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
### Checklist
|
||||
|
||||
- I have searched related issues but cannot get the expected help.
|
||||
- I have read related documents and don't know what to do.
|
||||
|
||||
### Describe the question you meet
|
||||
|
||||
\[here\]
|
||||
|
||||
### Post related information
|
||||
|
||||
1. The output of `pip list | grep "mmcv\|mmcls\|^torch"`
|
||||
\[here\]
|
||||
2. Your config file if you modified it or created a new one.
|
||||
|
||||
```python
|
||||
[here]
|
||||
```
|
||||
|
||||
3. Your train log file if you meet the problem during training.
|
||||
\[here\]
|
||||
4. Other code you modified in the `mmcls` folder.
|
||||
\[here\]
|
||||
Loading…
Reference in New Issue