Skip to content

Commit

Permalink
[Enhance] Update issue form and management file (#512)
Browse files Browse the repository at this point in the history
* add issue/pr management file

* update issue template

* fix lint

* fix typo

* update
  • Loading branch information
fangyixiao18 authored Oct 17, 2022
1 parent de6307e commit ad22113
Show file tree
Hide file tree
Showing 8 changed files with 177 additions and 78 deletions.
94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: "🐞 Bug report"
description: "Create a report to help us reproduce and fix the bug"
labels: Bug
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/mmselfsup/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.
**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/mmselfsup/issues) and [Discussions](https://github.com/open-mmlab/mmselfsup/discussions) but cannot get the expected help.
required: true
- label: I have read the [documentation](https://mmselfsup.readthedocs.io/en/latest/) but cannot get the expected help.
required: true
- label: The bug has not been fixed in the [latest version](https://github.com/open-mmlab/mmselfsup).
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: textarea
attributes:
label: Environment
description: |
Please run `python mmselfsup/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.
Did you make any modifications on the code or config? Are you clear about what you have modified?
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?
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: 🚀 Feature request
description: Suggest an idea for this project
labels: [Feature-Request]
title: "[Feature] "

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

- type: textarea
attributes:
label: What is the feature?
validations:
required: true

- type: textarea
attributes:
label: What alternatives have you considered?
description: |
Add any other context or screenshots about the feature request here.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/3-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: 📚 Documentation
description: Report an issue related to https://mmselfsup.readthedocs.io/en/latest/.
labels: "Documentation"
title: "[Docs] "

body:
- type: textarea
attributes:
label: 📚 The doc issue
description: >
A clear and concise description of what content in https://mmselfsup.readthedocs.io/en/latest/ is an 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 🎉!
8 changes: 7 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
blank_issues_enabled: false

contact_links:
- name: MMSelfSup Documentation
- name: 📚 MMSelfSup Documentation
url: https://mmselfsup.readthedocs.io/en/latest/
about: Check if your question is answered in docs
- name: 💬 Forum
url: https://github.com/open-mmlab/mmselfsup/discussions
about: Ask general usage questions and discuss with other MMSelfSup community members
- name: 🌐 Explore OpenMMLab
url: https://openmmlab.com/
about: Get know more about OpenMMLab
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

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

This file was deleted.

44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/unexpected_report.md

This file was deleted.

20 changes: 20 additions & 0 deletions .owner.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# assign issues to owners automatically
assign:
issues: enabled # or disabled
pull_requests: enabled # or disabled
# assign strategy, both issues and pull requests follow the same strategy
strategy:
# random
# round-robin
daily-shift-based
schedule:
'*/1 * * * *'
# assignees
assignees:
- fangyixiao18
- soonera
- Jiahao000
- YuanLiuuuuuu
- tonysy
- wangbo-zhao
- fangyixiao18

0 comments on commit ad22113

Please sign in to comment.