Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #749

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: "🐞 Bug report"
description: "Create a report to help us reproduce and fix the bug"
labels: "kind/bug,status/unconfirmed"
title: "[Bug] "

body:
- type: markdown
attributes:
value: |
If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [here](https://github.com/open-mmlab/mmtracking/pulls)!
If this issue is about installing MMCV, please file an issue at [MMCV](https://github.com/open-mmlab/mmcv/issues/new/choose).
If you need our help, please fill in as much of the following form as you're able to.
**The less clear the description, the longer it will take to solve it.**
- type: checkboxes
attributes:
label: Prerequisite
description: Please check the following items before creating a new issue.
options:
- label: I have searched [Issues](https://github.com/open-mmlab/mmtracking/issues) and [Discussions](https://github.com/open-mmlab/mmtracking/discussions) but cannot get the expected help.
required: true
- label: I have read the [FAQ documentation](https://mmtracking.readthedocs.io/en/1.x/notes/faq.html) but cannot get the expected help.
required: true
- label: The bug has not been fixed in the [latest version (master)](https://github.com/open-mmlab/mmtracking) or [latest version (1.x)](https://github.com/open-mmlab/mmtracking/tree/dev-1.x).
required: true

- type: dropdown
id: task
attributes:
label: Task
description: The problem arises when
options:
- I'm using the official example scripts/configs for the officially supported tasks/models/datasets.
- I have modified the scripts/configs, or I'm working on my own tasks/models/datasets.
validations:
required: true

- type: dropdown
id: branch
attributes:
label: Branch
description: The problem arises when I'm working on
options:
- master branch https://github.com/open-mmlab/mmtracking
- 1.x branch https://github.com/open-mmlab/mmtracking/tree/1.x
validations:
required: true


- type: textarea
attributes:
label: Environment
description: |
Please run `python mmedit/utils/collect_env.py` to collect necessary environment information and copy-paste it here.
You may add additional information that may be helpful for locating the problem, such as
- How you installed PyTorch \[e.g., pip, conda, source\]
- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
validations:
required: true
- type: textarea
attributes:
label: Reproduces the problem - code sample
description: |
Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
placeholder: |
```python
# Sample code to reproduce the problem
```
validations:
required: true
- type: textarea
attributes:
label: Reproduces the problem - command or script
description: |
What command or script did you run?
placeholder: |
```shell
The command or script you run.
```
validations:
required: true
- type: textarea
attributes:
label: Reproduces the problem - error message
description: |
Please provide the error message or logs you got, with the full traceback.
placeholder: |
```
The error message or logs you got, with the full traceback.
```
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: Tell us anything else you think we should know.
placeholder: |
1. What's your expected result?
2. What dataset did you use?
3. What do you think might be the reason?
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 🚀 Feature request
description: Suggest an idea for this project
labels: "kind/enhancement,status/unconfirmed"
title: "[Feature] "

body:
- type: markdown
attributes:
value: |
We strongly appreciate you creating a PR to implement this feature [here](https://github.com/open-mmlab/mmtracking/pulls)!
If you need our help, please fill in as much of the following form as you're able to.
**The less clear the description, the longer it will take to solve it.**
- type: textarea
attributes:
label: What's the feature?
description: |
Tell us more about the feature and how this feature can help.
placeholder: |
E.g., It is inconvenient when \[....\].
This feature can \[....\].
validations:
required: true

- type: textarea
attributes:
label: Any other context?
description: |
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.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/3-new-model.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "\U0001F31F New model/dataset/scheduler addition"
description: Submit a proposal/request to implement a new model / dataset / scheduler
labels: "kind/feature,status/unconfirmed"
title: "[New Models] "


body:
- type: textarea
id: description-request
validations:
required: true
attributes:
label: Model/Dataset/Scheduler description
description: |
Put any and all important information relative to the model/dataset/scheduler
- type: checkboxes
attributes:
label: Open source status
description: |
Please provide the open-source status, which would be very helpful
options:
- label: "The model implementation is available"
- label: "The model weights are available."
- type: textarea
id: additional-info
attributes:
label: Provide useful links for the implementation
description: |
Please provide information regarding the implementation, the weights, and the authors.
Please mention the authors by @gh-username if you're aware of their usernames.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/4-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: 📚 Documentation
description: Report an issue related to the documentation.
labels: "kind/doc,status/unconfirmed"
title: "[Docs] "

body:
- type: dropdown
id: branch
attributes:
label: Branch
description: This issue is related to the
options:
- master branch https://mmtracking.readthedocs.io/en/latest/
- 1.x branch https://mmtracking.readthedocs.io/en/1.x/
validations:
required: true

- type: textarea
attributes:
label: 📚 The doc issue
description: >
A clear and concise description the issue.
validations:
required: true

- type: textarea
attributes:
label: Suggest a potential alternative/fix
description: >
Tell us how we could improve the documentation in this regard.
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/5-reimplementation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: "💥 Reimplementation Questions"
description: "Ask about questions during model reimplementation"


body:
- type: markdown
attributes:
value: |
If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [here](https://github.com/open-mmlab/mmtracking/pulls)!

- type: checkboxes
attributes:
label: Prerequisite
description: Please check the following items before creating a new issue.
options:
- label: I have searched [the existing and past issues](https://github.com/open-mmlab/mmtracking/issues) but cannot get the expected help.
required: true
- label: I have read the [FAQ documentation](https://mmtracking.readthedocs.io/en/latest/faq.html) but cannot get the expected help.
required: true
- label: The bug has not been fixed in the [latest version](https://github.com/open-mmlab/mmtracking).
required: true
validations:
required: true

- type: textarea
attributes:
label: 💬 Describe the reimplementation questions
description: |
A clear and concise description of what the problem you meet and what have you done.
There are several common situations in the reimplementation issues as below

1. Reimplement a model in the model zoo using the provided configs
2. Reimplement a model in the model zoo on other dataset (e.g., custom datasets)
3. Reimplement a custom model but all the components are implemented in MMDetection
4. Reimplement a custom model with new modules implemented by yourself

There are several things to do for different cases as below.

- For case 1 & 3, please follow the steps in the following sections thus we could help to quick identify the issue.
- 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.
- 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.
placeholder: |
A clear and concise description of what the bug is.
What config dir you run?

```none
A placeholder for the config.
```

```shell
The command or script you run.
```

```
The error message or logs you got, with the full traceback.
```
validations:
required: true

- type: textarea
attributes:
label: Environment
description: |
Please run `python mmdet/utils/collect_env.py` to collect necessary environment information and paste it here.
You may add addition that may be helpful for locating the problem, such as
- How you installed PyTorch \[e.g., pip, conda, source\]
- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
validations:
required: true

- type: textarea
attributes:
label: Expected results
description: If applicable, paste the related results here, e.g., what you expect and what you get.
placeholder: |
```none
A placeholder for results comparison
```

- type: textarea
attributes:
label: Additional information
description: Tell us anything else you think we should know.
placeholder: |
1. Did you make any modifications on the code or config? Did you understand what you have modified?
2. What dataset did you use?
3. What do you think might be the reason?
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/error-report.md

This file was deleted.

21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/general_questions.md

This file was deleted.

Loading