Skip to content

Commit 962fc83

Browse files
VVssssskVVsssssk
authored
improve issue template (#1950)
1 parent fcb4545 commit 962fc83

9 files changed

+210
-140
lines changed

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

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: "🐞 Bug report"
2+
description: "Create a report to help us reproduce and fix the bug"
3+
labels: "kind/bug,status/unconfirmed"
4+
title: "[Bug] "
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
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/mmdetection3d/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 to.
13+
14+
**The less clear the description, the longer it will take to solve it.**
15+
16+
- type: checkboxes
17+
attributes:
18+
label: Prerequisite
19+
description: Please check the following items before creating a new issue.
20+
options:
21+
- label: I have searched [Issues](https://github.com/open-mmlab/mmdetection3d/issues) and [Discussions](https://github.com/open-mmlab/mmdetection3d/discussions) but cannot get the expected help.
22+
required: true
23+
- label: I have read the [FAQ documentation](https://github.com/open-mmlab/mmdetection3d/blob/1.1/docs/en/notes/faq.md) but cannot get the expected help.
24+
required: true
25+
- label: The bug has not been fixed in the [latest version (dev)](https://github.com/open-mmlab/mmdetection3d/tree/dev) or [latest version (1.x)](https://github.com/open-mmlab/mmdetection3d/tree/dev-1.x).
26+
required: true
27+
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/mmdetection3d
46+
- 1.1x branch https://github.com/open-mmlab/mmdetection3d/tree/1.1
47+
validations:
48+
required: true
49+
50+
51+
- type: textarea
52+
attributes:
53+
label: Environment
54+
description: |
55+
Please run `python mmdet3d/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
61+
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: |
68+
```python
69+
# Sample code to reproduce the problem
70+
```
71+
validations:
72+
required: true
73+
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: |
80+
```shell
81+
The command or script you run.
82+
```
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
attributes:
88+
label: Reproduces the problem - error message
89+
description: |
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+
```
95+
validations:
96+
required: true
97+
98+
- type: textarea
99+
attributes:
100+
label: Additional information
101+
description: Tell us anything else you think we should know.
102+
placeholder: |
103+
1. What's your expected result?
104+
2. What dataset did you use?
105+
3. What do you think might be the reason?

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
labels: "kind/enhancement,status/unconfirmed"
4+
title: "[Feature] "
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
We strongly appreciate you creating a PR to implement this feature [here](https://github.com/open-mmlab/mmdetection3d/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.**
14+
15+
- type: textarea
16+
attributes:
17+
label: What's the feature?
18+
description: |
19+
Tell us more about the feature and how this feature can help.
20+
placeholder: |
21+
E.g., It is inconvenient when \[....\].
22+
This feature can \[....\].
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Any other context?
29+
description: |
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: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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+
6+
7+
body:
8+
- type: textarea
9+
id: description-request
10+
validations:
11+
required: true
12+
attributes:
13+
label: Model/Dataset/Scheduler description
14+
description: |
15+
Put any and all important information relative to the model/dataset/scheduler
16+
17+
- type: checkboxes
18+
attributes:
19+
label: Open source status
20+
description: |
21+
Please provide the open-source status, which would be very helpful
22+
options:
23+
- label: "The model implementation is available"
24+
- label: "The model weights are available."
25+
26+
- type: textarea
27+
id: additional-info
28+
attributes:
29+
label: Provide useful links for the implementation
30+
description: |
31+
Please provide information regarding the implementation, the weights, and the authors.
32+
Please mention the authors by @gh-username if you're aware of their usernames.

‎.github/ISSUE_TEMPLATE/4-documentation.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: 📚 Documentation
2+
description: Report an issue related to the documentation.
3+
labels: "kind/doc,status/unconfirmed"
4+
title: "[Docs] "
5+
6+
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://mmdetection3d.readthedocs.io/en/latest/
14+
- 1.1x branch https://mmdetection3d.readthedocs.io/en/1.1/
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
attributes:
20+
label: 📚 The doc issue
21+
description: >
22+
A clear and concise description the issue.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Suggest a potential alternative/fix
29+
description: >
30+
Tell us how we could improve the documentation in this regard.
31+
- type: markdown
32+
attributes:
33+
value: >
34+
Thanks for contributing 🎉!

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
11
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: 💬 Forum
5+
url: https://github.com/open-mmlab/mmdetection3d/discussions
6+
about: Ask general usage questions and discuss with other MMDetection3d 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 & 45 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.

‎.github/ISSUE_TEMPLATE/reimplementation_questions.md

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

0 commit comments

Comments
 (0)