Skip to content

Commit 37dca06

Browse files
gaotongxiaoHarold-lkk
gaotongxiao
and
Harold-lkk
authored
Issue Template (#1663)
* [Template] Refactor issue template (#1449) * Refactor issue template * add contact * [Template] issue template (#1489) * improve issue template * fix comment Co-authored-by: liukuikun <[email protected]>
1 parent 0aa5d7b commit 37dca06

File tree

14 files changed

+332
-140
lines changed

14 files changed

+332
-140
lines changed

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

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: "🐞 Bug report"
2+
description: "Create a report to help us reproduce and fix the bug"
3+
labels: bug
4+
title: "[Bug] "
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Note
11+
For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmocr/discussions)
12+
If this issue is about installing MMCV, please file an issue at [MMCV](https://github.com/open-mmlab/mmcv/issues/new/choose).
13+
If it's anything about model deployment, please raise it to [MMDeploy](https://github.com/open-mmlab/mmdeploy)
14+
15+
Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.**
16+
17+
- type: checkboxes
18+
attributes:
19+
label: Prerequisite
20+
description: Please check the following items before creating a new issue.
21+
options:
22+
- label: I have searched [Issues](https://github.com/open-mmlab/mmocr/issues) and [Discussions](https://github.com/open-mmlab/mmocr/discussions) but cannot get the expected help.
23+
required: true
24+
# - label: I have read the [FAQ documentation](https://mmocr.readthedocs.io/en/1.x/notes/4_faq.html) but cannot get the expected help.
25+
# required: true
26+
- label: The bug has not been fixed in the [latest version (0.x)](https://github.com/open-mmlab/mmocr) or [latest version (1.x)](https://github.com/open-mmlab/mmocr/tree/dev-1.x).
27+
required: true
28+
29+
- type: dropdown
30+
id: task
31+
attributes:
32+
label: Task
33+
description: The problem arises when
34+
options:
35+
- I'm using the official example scripts/configs for the officially supported tasks/models/datasets.
36+
- I have modified the scripts/configs, or I'm working on my own tasks/models/datasets.
37+
validations:
38+
required: true
39+
40+
- type: dropdown
41+
id: branch
42+
attributes:
43+
label: Branch
44+
description: The problem arises when I'm working on
45+
options:
46+
- main branch https://github.com/open-mmlab/mmocr
47+
- 1.x branch https://github.com/open-mmlab/mmocr/tree/dev-1.x
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
attributes:
53+
label: Environment
54+
description: |
55+
Please run `python mmocr/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+
92+
Tip: You can attach images or log files by dragging them into the text area..
93+
placeholder: |
94+
```
95+
The error message or logs you got, with the full traceback.
96+
```
97+
validations:
98+
required: true
99+
100+
- type: textarea
101+
attributes:
102+
label: Additional information
103+
description: |
104+
Tell us anything else you think we should know.
105+
106+
Tip: You can attach images or log files by dragging them into the text area.
107+
placeholder: |
108+
1. What's your expected result?
109+
2. What dataset did you use?
110+
3. What do you think might be the reason?
111+
112+
- type: markdown
113+
attributes:
114+
value: |
115+
## Acknowledgement
116+
Thanks for taking the time to fill out this report.
117+
118+
If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [**Here**](https://github.com/open-mmlab/mmocr/pulls)!
119+
Please refer to [**Contribution Guide**](https://mmocr.readthedocs.io/en/dev-1.x/notes/contribution_guide.html) for contributing.
120+
121+
Welcome to join our [**Community**](https://mmocr.readthedocs.io/en/latest/contact.html) to discuss together. 👬

‎.github/ISSUE_TEMPLATE/2-feature_request.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
labels: [feature-request]
4+
title: "[Feature] "
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Note
11+
For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmocr/discussions)
12+
13+
Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.**
14+
15+
- type: textarea
16+
attributes:
17+
label: What is the feature?
18+
description: Tell us more about the feature and how this feature can help.
19+
placeholder: |
20+
E.g., It is inconvenient when \[....\].
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: Any other context?
27+
description: |
28+
Have you considered any alternative solutions or features? If so, what are they? Also, feel free to add any other context or screenshots about the feature request here.
29+
30+
- type: markdown
31+
attributes:
32+
value: |
33+
## Acknowledgement
34+
Thanks for taking the time to fill out this report.
35+
36+
We strongly appreciate you creating a new PR to implement it [**Here**](https://github.com/open-mmlab/mmocr/pulls)!
37+
Please refer to [**Contribution Guide**](https://mmocr.readthedocs.io/en/dev-1.x/notes/contribution_guide.html) for contributing.
38+
39+
Welcome to join our [**Community**](https://mmocr.readthedocs.io/en/latest/contact.html) to discuss together. 👬

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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: "\U0001F31F New model/dataset/scheduler addition"
2+
description: Submit a proposal/request to implement a new model / dataset / scheduler
3+
labels: [ "feature-request" ]
4+
title: "[New Models] "
5+
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
## Note
12+
For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmocr/discussions)
13+
14+
Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.**
15+
16+
- type: textarea
17+
id: description-request
18+
validations:
19+
required: true
20+
attributes:
21+
label: Model/Dataset/Scheduler description
22+
description: |
23+
Put any and all important information relative to the model/dataset/scheduler
24+
25+
- type: checkboxes
26+
attributes:
27+
label: Open source status
28+
description: |
29+
Please provide the open-source status, which would be very helpful
30+
options:
31+
- label: "The model implementation is available"
32+
- label: "The model weights are available."
33+
34+
- type: textarea
35+
id: additional-info
36+
attributes:
37+
label: Provide useful links for the implementation
38+
description: |
39+
Please provide information regarding the implementation, the weights, and the authors.
40+
Please mention the authors by @gh-username if you're aware of their usernames.
41+
42+
- type: markdown
43+
attributes:
44+
value: |
45+
## Acknowledgement
46+
Thanks for taking the time to fill out this report.
47+
48+
We strongly appreciate you creating a new PR to implement it [**Here**](https://github.com/open-mmlab/mmocr/pulls)!
49+
Please refer to [**Contribution Guide**](https://mmocr.readthedocs.io/en/dev-1.x/notes/contribution_guide.html) for contributing.
50+
51+
Welcome to join our [**Community**](https://mmocr.readthedocs.io/en/latest/contact.html) to discuss together. 👬

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: 📚 Documentation
2+
description: Report an issue related to the documentation.
3+
labels: "docs"
4+
title: "[Docs] "
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Note
11+
For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmocr/discussions)
12+
Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.**
13+
14+
- type: dropdown
15+
id: branch
16+
attributes:
17+
label: Branch
18+
description: This issue is related to the
19+
options:
20+
- master branch https://mmocr.readthedocs.io/en/latest/
21+
- 1.x branch https://mmocr.readthedocs.io/en/dev-1.x/
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: 📚 The doc issue
28+
description: >
29+
A clear and concise description the issue.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
attributes:
35+
label: Suggest a potential alternative/fix
36+
description: >
37+
Tell us how we could improve the documentation in this regard.
38+
39+
- type: markdown
40+
attributes:
41+
value: |
42+
## Acknowledgement
43+
Thanks for taking the time to fill out this report.
44+
45+
If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [**here**](https://github.com/open-mmlab/mmocr/pulls)!
46+
Please refer to [**Contribution Guide**](https://mmocr.readthedocs.io/en/dev-1.x/notes/contribution_guide.html) for contributing.
47+
48+
Welcome to join our [**Community**](https://mmocr.readthedocs.io/en/latest/contact.html) to discuss together. 👬

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
blank_issues_enabled: false
22

33
contact_links:
4+
- name: 💬 Forum
5+
url: https://github.com/open-mmlab/mmocr/discussions
6+
about: Ask general usage questions and discuss with other MMOCR community members
47
- name: MMOCR Documentation
58
url: https://mmocr.readthedocs.io/en/latest/
69
about: Check if your question is answered in docs
10+
- name: 🌐 Explore OpenMMLab
11+
url: https://openmmlab.com/
12+
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.

0 commit comments

Comments
 (0)