diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 7f35398e34..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' ---- - -Thanks for your bug report. We appreciate it a lot. - -**Checklist** - -1. I have searched related issues but cannot get the expected help. -2. I have read the [FAQ documentation](https://github.com/open-mmlab/mmdeploy/blob/master/docs/en/faq.md) but cannot get the expected help. -3. The bug has not been fixed in the latest version. - -**Describe the bug** - -A clear and concise description of what the bug is. - -**Reproduction** - -1. What command or script did you run? - -```none -A placeholder for the command. -``` - -2. Did you make any modifications on the code or config? Did you understand what you have modified? - -**Environment** - -1. Please run `python tools/check_env.py` to collect necessary environment information and paste it here. -2. 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.) - -**Error traceback** - -If applicable, paste the error trackback here. - -```none -A placeholder for trackback. -``` - -**Bug fix** - -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! diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..79bc39f42c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,56 @@ +name: Bug report +description: Create a report to help us improve + + +body: +- type: checkboxes + attributes: + label: Checklist + options: + - label: I have searched related issues but cannot get the expected help. + - label: 2. I have read the [FAQ documentation](https://github.com/open-mmlab/mmdeploy/blob/master/docs/en/faq.md) but cannot get the expected help. + - label: 3. The bug has not been fixed in the latest version. +- type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true +- type: textarea + attributes: + label: Reproduction + description: | + 1. What command or script did you run? + + 2. Did you make any modifications on the code or config? Did you understand what you have modified? + placeholder: | + A placeholder for the command. + validations: + required: true +- type: textarea + attributes: + label: Environment + description: | + 1. Please run `python tools/check_env.py` to collect necessary environment information and paste it here. + 2. 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.) + placeholder: Environment here. + render: Shell + validations: + required: true +- type: textarea + attributes: + label: Error traceback + description: | + If applicable, paste the error trackback here. + placeholder: Logs and traceback here. + render: Shell +- type: markdown + attributes: + value: > + 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.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index dd2a0c342b..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' ---- - -**Describe the feature** - -**Motivation** - -A clear and concise description of the motivation of the feature. -Ex1. It is inconvenient when \[....\]. - -**Related resources** - -If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful. - -**Additional context** - -Add any other context or screenshots about the feature request here. -If you would like to implement the feature and create a PR, please leave a comment here and that would be much appreciated. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000000..92e9a914d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,27 @@ +name: Feature request +description: Suggest an idea for this project + +body: +- type: markdown + attributes: + value: > + ## Describe the feature +- type: textarea + attributes: + label: Motivation + description: | + A clear and concise description of the motivation of the feature. + Ex1. It is inconvenient when \[....\]. + validations: + required: true +- type: textarea + attributes: + label: Related resources + description: | + If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful. +- type: textarea + attributes: + label: Additional context + description: | + Add any other context or screenshots about the feature request here. + If you would like to implement the feature and create a PR, please leave a comment here and that would be much appreciated.