diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml index 8723a2b7..4d3e51fa 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -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] " @@ -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 @@ -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 @@ -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 @@ -57,8 +69,6 @@ body: ```python # Sample code to reproduce the problem ``` - validations: - required: true - type: textarea attributes: @@ -69,8 +79,6 @@ body: ```shell The command or script you run. ``` - validations: - required: true - type: textarea attributes: @@ -81,8 +89,6 @@ body: ``` The error message or logs you got, with the full traceback. ``` - validations: - required: true - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml index bb933338..f97fa3d0 100644 --- a/.github/ISSUE_TEMPLATE/2-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml @@ -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: diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml index 3036e38b..c265ad94 100644 --- a/.github/ISSUE_TEMPLATE/3-documentation.yml +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -1,4 +1,4 @@ -name: 📚 Documentation +name: 📚 Documentation Issue description: Report an issue related to https://mmselfsup.readthedocs.io/en/latest/. labels: "Documentation" title: "[Docs] " @@ -6,7 +6,7 @@ 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: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d5b7cb87..eaa8559c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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