Skip to content

Commit

Permalink
Update issue template (#550)
Browse files Browse the repository at this point in the history
* update issue template

* fix lint
  • Loading branch information
fangyixiao18 committed Oct 28, 2022
1 parent 560446a commit 595909c
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 25 deletions.
42 changes: 24 additions & 18 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "🐞 Bug report"
name: "🐞 Bug Report"
description: "Create a report to help us reproduce and fix the bug"
labels: Bug
title: "[Bug] "
Expand All @@ -13,6 +13,17 @@ body:
**The less clear the description, the longer it will take to solve it.**
- type: dropdown
id: version
attributes:
label: Branch
description: Which branch/version are you using?
options:
- master branch (0.x version, such as `v0.10.0`, or `dev` branch)
- 1.x branch (1.x version, such as `v1.0.0rc2`, or `dev-1.x` branch)
validations:
required: true

- type: checkboxes
attributes:
label: Prerequisite
Expand All @@ -25,17 +36,6 @@ body:
- 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
Expand All @@ -47,6 +47,18 @@ body:
validations:
required: true

- type: textarea
id: description
validations:
required: true
attributes:
label: Describe the bug
description: |
Please provide a clear and concise description of what the bug is.
Preferably a simple and minimal code snippet is provided below, so that we can reproduce the error by running the code.
placeholder: |
A clear and concise description of what the bug is.
- type: textarea
attributes:
label: Reproduces the problem - code sample
Expand All @@ -57,8 +69,6 @@ body:
```python
# Sample code to reproduce the problem
```
validations:
required: true
- type: textarea
attributes:
Expand All @@ -69,8 +79,6 @@ body:
```shell
The command or script you run.
```
validations:
required: true
- type: textarea
attributes:
Expand All @@ -81,8 +89,6 @@ body:
```
The error message or logs you got, with the full traceback.
```
validations:
required: true
- type: textarea
attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: 🚀 Feature request
name: 🚀 Feature Request
description: Suggest an idea for this project
labels: [Feature-Request]
labels: [Feature]
title: "[Feature] "

body:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/3-documentation.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: 📚 Documentation
name: 📚 Documentation Issue
description: Report an issue related to https://mmselfsup.readthedocs.io/en/latest/.
labels: "Documentation"
title: "[Docs] "

body:
- type: textarea
attributes:
label: 📚 The doc issue
label: The doc issue
description: >
A clear and concise description of what content in https://mmselfsup.readthedocs.io/en/latest/ is an issue.
validations:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,12 +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
- 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
- name: 🌐 Explore OpenMMLab (官网)
url: https://openmmlab.com/
about: Get know more about OpenMMLab

0 comments on commit 595909c

Please sign in to comment.