Create issue templates (#358)

* Create issue templates

* Fix lint.
pull/341/head^2
Ma Zerun 2021-07-14 15:18:43 +08:00 committed by GitHub
parent a97ccd5579
commit eb7c70c5c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 226 additions and 0 deletions

28
.github/ISSUE_TEMPLATE/----.md vendored 100644
View File

@ -0,0 +1,28 @@
---
name: 寻求帮助
about: 遇到问题并寻求帮助
title: ''
labels: help wanted
assignees: ''
---
### 首先确认以下内容
- 我已经查询了相关的 issue但没有找到需要的帮助。
- 我已经阅读了相关文档,但仍不知道如何解决。
### 描述你遇到的问题
[填写这里]
### 相关信息
1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出
[填写这里]
2. 如果你修改了,或者使用了新的配置文件,请在这里写明
```python
[填写这里]
```
3. 如果你是在训练过程中遇到的问题,请填写完整的训练日志和报错信息
[填写这里]
4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改,请在这里写明
[填写这里]

30
.github/ISSUE_TEMPLATE/---.md vendored 100644
View File

@ -0,0 +1,30 @@
---
name: 新功能
about: 为项目提一个建议
title: "[Feature]"
labels: enhancement
assignees: ''
---
### 描述这个功能
[填写这里]
### 动机
请简要说明以下为什么需要添加这个新功能
例1. 现在进行 xxx 的时候不方便
例2. 最近的论文中提出了有一个很有帮助的 xx
[填写这里]
### 相关资源
是否有相关的官方实现或者第三方实现?这些会很有参考意义。
[填写这里]
### 其他相关信息
其他和这个功能相关的信息或者截图,请放在这里。
另外如果你愿意参与实现这个功能并提交 PR请在这里说明我们将非常欢迎。
[填写这里]

View File

@ -0,0 +1,37 @@
---
name: 报告 Bug
about: 报告问题以帮助我们提升
title: "[Bug]"
labels: bug
assignees: ''
---
### 描述 bug
简单地描述一下遇到了什么 bug
[填写这里]
### 复现流程
在命令行中执行的详细操作
```shell
[填写这里]
```
### 相关信息
1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出
[填写这里]
2. 如果你修改了,或者使用了新的配置文件,请在这里写明
```python
[填写这里]
```
3. 如果你是在训练过程中遇到的问题,请填写完整的训练日志和报错信息
[填写这里]
4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改,请在这里写明
[填写这里]
### 附加内容
任何其他有关该 bug 的信息、截图等
[填写这里]

28
.github/ISSUE_TEMPLATE/--.md vendored 100644
View File

@ -0,0 +1,28 @@
---
name: 提问
about: 遇到问题并寻求帮助
title: ''
labels: help wanted
assignees: ''
---
### 首先确认以下内容
- 我已经查询了相关的 issue但没有找到需要的帮助。
- 我已经阅读了相关文档,但仍不知道如何解决。
### 描述你遇到的问题
[填写这里]
### 相关信息
1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出
[填写这里]
2. 如果你修改了,或者使用了新的配置文件,请在这里写明
```python
[填写这里]
```
3. 如果你是在训练过程中遇到的问题,请填写完整的训练日志和报错信息
[填写这里]
4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改,请在这里写明
[填写这里]

View File

@ -0,0 +1,37 @@
---
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]

View File

@ -0,0 +1,8 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''
---

View File

@ -0,0 +1,30 @@
---
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]

View File

@ -0,0 +1,28 @@
---
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]