Skip to content

Commit e422ee9

Browse files
authored
[Enhancement] improve issue template (#9125)
* [Enhancement] improve issue template * update
1 parent 92dd59e commit e422ee9

File tree

5 files changed

+100
-47
lines changed

5 files changed

+100
-47
lines changed
Lines changed: 58 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,97 @@
11
name: "🐞 Bug report"
22
description: "Create a report to help us reproduce and fix the bug"
3-
3+
labels: "kind/bug,status/unconfirmed"
4+
title: "[Bug] "
45

56
body:
67
- type: markdown
78
attributes:
89
value: |
9-
Thank you for reporting this issue to help us improve!
1010
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)!
1111
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.
12+
If you need our help, please fill in as much of the following form as you're able to.
13+
14+
**The less clear the description, the longer it will take to solve it.**
1315
1416
- type: checkboxes
1517
attributes:
1618
label: Prerequisite
1719
description: Please check the following items before creating a new issue.
1820
options:
19-
- label: I have searched [the existing and past issues](https://github.com/open-mmlab/mmdetection/issues) but cannot get the expected help.
21+
- label: I have searched [Issues](https://github.com/open-mmlab/mmdetection/issues) and [Discussions](https://github.com/open-mmlab/mmdetection/discussions) but cannot get the expected help.
2022
required: true
2123
- label: I have read the [FAQ documentation](https://mmdetection.readthedocs.io/en/latest/faq.html) but cannot get the expected help.
2224
required: true
23-
- label: The bug has not been fixed in the [latest version](https://github.com/open-mmlab/mmdetection).
25+
- label: The bug has not been fixed in the [latest version (master)](https://github.com/open-mmlab/mmdetection) or [latest version (3.x)](https://github.com/open-mmlab/mmdetection/tree/dev-3.x).
2426
required: true
2527

28+
- type: dropdown
29+
id: task
30+
attributes:
31+
label: Task
32+
description: The problem arises when
33+
options:
34+
- I'm using the official example scripts/configs for the officially supported tasks/models/datasets.
35+
- I have modified the scripts/configs, or I'm working on my own tasks/models/datasets.
36+
validations:
37+
required: true
38+
39+
- type: dropdown
40+
id: branch
41+
attributes:
42+
label: Branch
43+
description: The problem arises when I'm working on
44+
options:
45+
- master branch https://github.com/open-mmlab/mmdetection
46+
- 3.x branch https://github.com/open-mmlab/mmdetection/tree/3.x
47+
validations:
48+
required: true
49+
50+
2651
- type: textarea
2752
attributes:
28-
label: 🐞 Describe the bug
53+
label: Environment
2954
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.
55+
Please run `python mmdet/utils/collect_env.py` to collect necessary environment information and copy-paste it here.
56+
You may add additional information that may be helpful for locating the problem, such as
57+
- How you installed PyTorch \[e.g., pip, conda, source\]
58+
- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
59+
validations:
60+
required: true
3461

62+
- type: textarea
63+
attributes:
64+
label: Reproduces the problem - code sample
65+
description: |
66+
Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
67+
placeholder: |
3568
```python
3669
# Sample code to reproduce the problem
3770
```
71+
validations:
72+
required: true
3873

74+
- type: textarea
75+
attributes:
76+
label: Reproduces the problem - command or script
77+
description: |
78+
What command or script did you run?
79+
placeholder: |
3980
```shell
4081
The command or script you run.
4182
```
42-
43-
```
44-
The error message or logs you got, with the full traceback.
45-
```
4683
validations:
4784
required: true
4885

4986
- type: textarea
5087
attributes:
51-
label: Environment
88+
label: Reproduces the problem - error message
5289
description: |
53-
Please run `python mmdet/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.)
90+
Please provide the error message or logs you got, with the full traceback.
91+
placeholder: |
92+
```
93+
The error message or logs you got, with the full traceback.
94+
```
5795
validations:
5896
required: true
5997

@@ -62,6 +100,6 @@ body:
62100
label: Additional information
63101
description: Tell us anything else you think we should know.
64102
placeholder: |
65-
1. Did you make any modifications on the code or config? Did you understand what you have modified?
103+
1. What's your expected result?
66104
2. What dataset did you use?
67105
3. What do you think might be the reason?
Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
name: 🚀 Feature request
22
description: Suggest an idea for this project
3-
labels: [feature request]
3+
labels: "kind/enhancement,status/unconfirmed"
4+
title: "[Feature] "
45

56
body:
67
- type: markdown
78
attributes:
89
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)!
10+
We strongly appreciate you creating a PR to implement this feature [here](https://github.com/open-mmlab/mmdetection/pulls)!
11+
If you need our help, please fill in as much of the following form as you're able to.
1112
12-
If you need our help, please fill in as much of the following form as you're able.
13+
**The less clear the description, the longer it will take to solve it.**
1314
1415
- type: textarea
1516
attributes:
16-
label: What is the problem this feature will solve?
17+
label: What's the feature?
18+
description: |
19+
Tell us more about the feature and how this feature can help.
1720
placeholder: |
1821
E.g., It is inconvenient when \[....\].
22+
This feature can \[....\].
1923
validations:
2024
required: true
2125

2226
- type: textarea
2327
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?
28+
label: Any other context?
3129
description: |
32-
Add any other context or screenshots about the feature request here.
30+
Have you considered any alternative solutions or features? If so, what are they?
31+
Also, feel free to add any other context or screenshots about the feature request here.

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
name: "\U0001F31F New model/dataset addition"
2-
description: Submit a proposal/request to implement a new model / dataset
3-
labels: [ "New model/dataset" ]
1+
name: "\U0001F31F New model/dataset/scheduler addition"
2+
description: Submit a proposal/request to implement a new model / dataset / scheduler
3+
labels: "kind/feature,status/unconfirmed"
4+
title: "[New Models] "
5+
46

57
body:
68
- type: textarea
79
id: description-request
810
validations:
911
required: true
1012
attributes:
11-
label: Model/Dataset description
13+
label: Model/Dataset/Scheduler description
1214
description: |
13-
Put any and all important information relative to the model/dataset
15+
Put any and all important information relative to the model/dataset/scheduler
1416
1517
- type: checkboxes
1618
attributes:

.github/ISSUE_TEMPLATE/4-documentation.yml

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
name: 📚 Documentation
2-
description: Report an issue related to https://mmdetection.readthedocs.io/en/latest/.
2+
description: Report an issue related to the documentation.
3+
labels: "kind/doc,status/unconfirmed"
4+
title: "[Docs] "
35

46
body:
7+
- type: dropdown
8+
id: branch
9+
attributes:
10+
label: Branch
11+
description: This issue is related to the
12+
options:
13+
- master branch https://mmdetection.readthedocs.io/en/latest/
14+
- 3.x branch https://mmdetection.readthedocs.io/en/3.x/
15+
validations:
16+
required: true
17+
518
- type: textarea
619
attributes:
720
label: 📚 The doc issue
821
description: >
9-
A clear and concise description of what content in https://mmdetection.readthedocs.io/en/latest/ is an issue.
22+
A clear and concise description the issue.
1023
validations:
1124
required: true
1225

@@ -15,7 +28,6 @@ body:
1528
label: Suggest a potential alternative/fix
1629
description: >
1730
Tell us how we could improve the documentation in this regard.
18-
1931
- type: markdown
2032
attributes:
2133
value: >

.github/ISSUE_TEMPLATE/5-reimplementation.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
11
name: "💥 Reimplementation Questions"
22
description: "Ask about questions during model reimplementation"
3-
3+
labels: "kind/enhancement,status/unconfirmed"
4+
title: "[Reimplementation] "
45

56
body:
67
- type: markdown
78
attributes:
89
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+
We strongly appreciate you creating a PR to implement this feature [here](https://github.com/open-mmlab/mmdetection/pulls)!
11+
If you need our help, please fill in as much of the following form as you're able to.
12+
13+
**The less clear the description, the longer it will take to solve it.**
1014
1115
- type: checkboxes
1216
attributes:
1317
label: Prerequisite
1418
description: Please check the following items before creating a new issue.
1519
options:
16-
- label: I have searched [the existing and past issues](https://github.com/open-mmlab/mmdetection/issues) but cannot get the expected help.
20+
- label: I have searched [Issues](https://github.com/open-mmlab/mmdetection/issues) and [Discussions](https://github.com/open-mmlab/mmdetection/discussions) but cannot get the expected help.
1721
required: true
1822
- label: I have read the [FAQ documentation](https://mmdetection.readthedocs.io/en/latest/faq.html) but cannot get the expected help.
1923
required: true
20-
- label: The bug has not been fixed in the [latest version](https://github.com/open-mmlab/mmdetection).
24+
- label: The bug has not been fixed in the [latest version (master)](https://github.com/open-mmlab/mmdetection) or [latest version (3.x)](https://github.com/open-mmlab/mmdetection/tree/dev-3.x).
2125
required: true
22-
validations:
23-
required: true
2426

2527
- type: textarea
2628
attributes:

0 commit comments

Comments
 (0)