Skip to content

Commit 1c702cc

Browse files
RangiLyuRangiLyu
authored
[Doc]: update issue template (#8802)
* update issue template * update issue template
1 parent ba69d69 commit 1c702cc

File tree

10 files changed

+245
-148
lines changed

10 files changed

+245
-148
lines changed

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

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: "🐞 Bug report"
2+
description: "Create a report to help us reproduce and fix the bug"
3+
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting this issue to help us improve!
10+
If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [here](https://github.com/open-mmlab/mmdetection/pulls)!
11+
If this issue is about installing MMCV, please file an issue at [MMCV](https://github.com/open-mmlab/mmcv/issues/new/choose).
12+
If you need our help, please fill in as much of the following form as you're able.
13+
14+
- type: checkboxes
15+
attributes:
16+
label: Prerequisite
17+
description: Please check the following items before creating a new issue.
18+
options:
19+
- label: I have searched [the existing and past issues](https://github.com/open-mmlab/mmdetection/issues) but cannot get the expected help.
20+
required: true
21+
- label: I have read the [FAQ documentation](https://mmdetection.readthedocs.io/en/latest/faq.html) but cannot get the expected help.
22+
required: true
23+
- label: The bug has not been fixed in the [latest version](https://github.com/open-mmlab/mmdetection).
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: 🐞 Describe the bug
29+
description: |
30+
Please provide a clear and concise description of what the bug is.
31+
Preferably a simple and minimal code snippet that we can reproduce the error by running the code.
32+
placeholder: |
33+
A clear and concise description of what the bug is.
34+
35+
```python
36+
# Sample code to reproduce the problem
37+
```
38+
39+
```shell
40+
The command or script you run.
41+
```
42+
43+
```
44+
The error message or logs you got, with the full traceback.
45+
```
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
attributes:
51+
label: Environment
52+
description: |
53+
Please run `python mmedit/utils/collect_env.py` to collect necessary environment information and paste it here.
54+
You may add addition that may be helpful for locating the problem, such as
55+
- How you installed PyTorch \[e.g., pip, conda, source\]
56+
- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
attributes:
62+
label: Additional information
63+
description: Tell us anything else you think we should know.
64+
placeholder: |
65+
1. Did you make any modifications on the code or config? Did you understand what you have modified?
66+
2. What dataset did you use?
67+
3. What do you think might be the reason?

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
labels: [feature request]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting an idea to make MMDetection better.
10+
We strongly appreciate you creating a PR to implete this feature [here](https://github.com/open-mmlab/mmdetection/pulls)!
11+
12+
If you need our help, please fill in as much of the following form as you're able.
13+
14+
- type: textarea
15+
attributes:
16+
label: What is the problem this feature will solve?
17+
placeholder: |
18+
E.g., It is inconvenient when \[....\].
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: What is the feature you are proposing to solve the problem?
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
attributes:
30+
label: What alternatives have you considered?
31+
description: |
32+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/3-new-model.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: "\U0001F31F New model/dataset addition"
2+
description: Submit a proposal/request to implement a new model / dataset
3+
labels: [ "New model/dataset" ]
4+
5+
body:
6+
- type: textarea
7+
id: description-request
8+
validations:
9+
required: true
10+
attributes:
11+
label: Model/Dataset description
12+
description: |
13+
Put any and all important information relative to the model/dataset
14+
15+
- type: checkboxes
16+
attributes:
17+
label: Open source status
18+
description: |
19+
Please provide the open-source status, which would be very helpful
20+
options:
21+
- label: "The model implementation is available"
22+
- label: "The model weights are available."
23+
24+
- type: textarea
25+
id: additional-info
26+
attributes:
27+
label: Provide useful links for the implementation
28+
description: |
29+
Please provide information regarding the implementation, the weights, and the authors.
30+
Please mention the authors by @gh-username if you're aware of their usernames.

‎.github/ISSUE_TEMPLATE/4-documentation.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: 📚 Documentation
2+
description: Report an issue related to https://mmdetection.readthedocs.io/en/latest/.
3+
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: 📚 The doc issue
8+
description: >
9+
A clear and concise description of what content in https://mmdetection.readthedocs.io/en/latest/ is an issue.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
attributes:
15+
label: Suggest a potential alternative/fix
16+
description: >
17+
Tell us how we could improve the documentation in this regard.
18+
19+
- type: markdown
20+
attributes:
21+
value: >
22+
Thanks for contributing 🎉!

‎.github/ISSUE_TEMPLATE/5-reimplementation.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: "💥 Reimplementation Questions"
2+
description: "Ask about questions during model reimplementation"
3+
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [here](https://github.com/open-mmlab/mmdetection/pulls)!
10+
11+
- type: checkboxes
12+
attributes:
13+
label: Prerequisite
14+
description: Please check the following items before creating a new issue.
15+
options:
16+
- label: I have searched [the existing and past issues](https://github.com/open-mmlab/mmdetection/issues) but cannot get the expected help.
17+
required: true
18+
- label: I have read the [FAQ documentation](https://mmdetection.readthedocs.io/en/latest/faq.html) but cannot get the expected help.
19+
required: true
20+
- label: The bug has not been fixed in the [latest version](https://github.com/open-mmlab/mmdetection).
21+
required: true
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: 💬 Describe the reimplementation questions
28+
description: |
29+
A clear and concise description of what the problem you meet and what have you done.
30+
There are several common situations in the reimplementation issues as below
31+
32+
1. Reimplement a model in the model zoo using the provided configs
33+
2. Reimplement a model in the model zoo on other dataset (e.g., custom datasets)
34+
3. Reimplement a custom model but all the components are implemented in MMDetection
35+
4. Reimplement a custom model with new modules implemented by yourself
36+
37+
There are several things to do for different cases as below.
38+
39+
- For case 1 & 3, please follow the steps in the following sections thus we could help to quick identify the issue.
40+
- For case 2 & 4, please understand that we are not able to do much help here because we usually do not know the full code and the users should be responsible to the code they write.
41+
- One suggestion for case 2 & 4 is that the users should first check whether the bug lies in the self-implemented code or the original code. For example, users can first make sure that the same model runs well on supported datasets. If you still need help, please describe what you have done and what you obtain in the issue, and follow the steps in the following sections and try as clear as possible so that we can better help you.
42+
placeholder: |
43+
A clear and concise description of what the bug is.
44+
What config dir you run?
45+
46+
```none
47+
A placeholder for the config.
48+
```
49+
50+
```shell
51+
The command or script you run.
52+
```
53+
54+
```
55+
The error message or logs you got, with the full traceback.
56+
```
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
attributes:
62+
label: Environment
63+
description: |
64+
Please run `python mmdet/utils/collect_env.py` to collect necessary environment information and paste it here.
65+
You may add addition that may be helpful for locating the problem, such as
66+
- How you installed PyTorch \[e.g., pip, conda, source\]
67+
- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
attributes:
73+
label: Expected results
74+
description: If applicable, paste the related results here, e.g., what you expect and what you get.
75+
placeholder: |
76+
```none
77+
A placeholder for results comparison
78+
```
79+
80+
- type: textarea
81+
attributes:
82+
label: Additional information
83+
description: Tell us anything else you think we should know.
84+
placeholder: |
85+
1. Did you make any modifications on the code or config? Did you understand what you have modified?
86+
2. What dataset did you use?
87+
3. What do you think might be the reason?

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
blank_issues_enabled: false
1+
blank_issues_enabled: true
22

33
contact_links:
4-
- name: Common Issues
5-
url: https://mmdetection.readthedocs.io/en/latest/faq.html
6-
about: Check if your issue already has solutions
7-
- name: MMDetection Documentation
8-
url: https://mmdetection.readthedocs.io/en/latest/
9-
about: Check if your question is answered in docs
4+
- name: 💬 Forum
5+
url: https://github.com/open-mmlab/mmdetection/discussions
6+
about: Ask general usage questions and discuss with other MMDetection community members
7+
- name: 🌐 Explore OpenMMLab
8+
url: https://openmmlab.com/
9+
about: Get know more about OpenMMLab

‎.github/ISSUE_TEMPLATE/error-report.md‎

Lines changed: 0 additions & 46 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/general_questions.md‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)