diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml similarity index 94% rename from .github/ISSUE_TEMPLATE/bug-report.yml rename to .github/ISSUE_TEMPLATE/1-bug-report.yml index 79bc39f42..bf6924789 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -1,6 +1,7 @@ -name: Bug report -description: Create a report to help us improve - +name: 🐞 Bug report +description: Create a report to help us reproduce and fix the bug +title: "[Bug] " +labels: ['Bug'] body: - type: checkboxes @@ -52,5 +53,3 @@ body: If you have already identified the reason, you can provide the information here. If you are willing to create a PR to fix it, please also leave a comment here and that would be much appreciated! Thanks for your bug report. We appreciate it a lot. - -labels: ['Bug'] diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/2-feature_request.yaml similarity index 69% rename from .github/ISSUE_TEMPLATE/feature_request.yaml rename to .github/ISSUE_TEMPLATE/2-feature_request.yaml index 92e9a914d..df6345c02 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yaml @@ -1,11 +1,15 @@ -name: Feature request +name: 🚀 Feature request description: Suggest an idea for this project +title: "[Feature] " body: - type: markdown attributes: - value: > - ## Describe the feature + value: | + We strongly appreciate you creating a PR to implement this feature [here](https://github.com/open-mmlab/mmdeploy/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: Motivation diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml new file mode 100644 index 000000000..b112c2aea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -0,0 +1,23 @@ +name: 📚 Documentation +description: Report an issue related to the documentation. +labels: "kind/doc,status/unconfirmed" +title: "[Docs] " + +body: +- 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 🎉! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 1f68f5166..bcf07914a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,12 @@ blank_issues_enabled: false contact_links: - - name: Common Issues + - name: 💥 FAQ url: https://github.com/open-mmlab/mmdeploy/blob/master/docs/en/faq.md about: Check if your issue already has solutions + - name: 💬 Forum + url: https://github.com/open-mmlab/mmdeploy/discussions + about: Ask general usage questions and discuss with other MMDeploy community members + - name: 🌐 Explore OpenMMLab + url: https://openmmlab.com/ + about: Get know more about OpenMMLab diff --git a/.github/ISSUE_TEMPLATE/general_questions.md b/.github/ISSUE_TEMPLATE/general_questions.md deleted file mode 100644 index f02dd63a8..000000000 --- a/.github/ISSUE_TEMPLATE/general_questions.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: General questions -about: Ask general questions to get help -title: '' -labels: '' -assignees: '' ----