From f6ffa6466069c05631080d16a8889250de651f46 Mon Sep 17 00:00:00 2001 From: grimoire Date: Tue, 6 Sep 2022 10:48:46 +0800 Subject: [PATCH 1/3] update bug report --- .github/ISSUE_TEMPLATE/bug-report.yml | 64 +++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..a9bebf923d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,64 @@ +name: Bug report +description: Create a report to help us improve + + +body: +- type: markdown + attributes: + value: > + ## 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. +- type: textarea + attributes: + label: Describe the bug + placeholder: | + + 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? + + ```none + A placeholder for the command. + ``` + + 2. Did you make any modifications on the code or config? Did you understand what you have modified? +- 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.) + validations: + required: true +- type: textarea + attributes: + label: Error traceback + description: | + If applicable, paste the error trackback here. + placeholder: | + ```none + A placeholder for trackback. + ``` + +- type: textarea + attributes: + label: Bug fix + description: | + 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! + +- type: markdown + attributes: + value: > + Thanks for your bug report. We appreciate it a lot. + +labels: ['Bug'] From 910bb7155d673d5a321cd2ef7224b0899ee24723 Mon Sep 17 00:00:00 2001 From: grimoire Date: Tue, 6 Sep 2022 11:20:47 +0800 Subject: [PATCH 2/3] update issue template --- .github/ISSUE_TEMPLATE/bug-report.md | 48 --------------------- .github/ISSUE_TEMPLATE/bug-report.yml | 27 +++++------- .github/ISSUE_TEMPLATE/feature_request.md | 23 ---------- .github/ISSUE_TEMPLATE/feature_request.yaml | 27 ++++++++++++ 4 files changed, 38 insertions(+), 87 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml 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 index a9bebf923d..ad959251dc 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -3,19 +3,17 @@ description: Create a report to help us improve body: -- type: markdown +- type: checkboxes attributes: - value: > - ## 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. + 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 - placeholder: | - - A clear and concise description of what the bug is. + description: A clear and concise description of what the bug is. validations: required: true - type: textarea @@ -30,6 +28,8 @@ body: ``` 2. Did you make any modifications on the code or config? Did you understand what you have modified? + validations: + required: true - type: textarea attributes: label: Environment @@ -49,16 +49,11 @@ body: ```none A placeholder for trackback. ``` - -- type: textarea - attributes: - label: Bug fix - description: | - 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! - - 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. From 48fa61053b9a39e600e84b56015dcfe3d626853a Mon Sep 17 00:00:00 2001 From: grimoire Date: Wed, 7 Sep 2022 14:21:08 +0800 Subject: [PATCH 3/3] update bug-report --- .github/ISSUE_TEMPLATE/bug-report.yml | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index ad959251dc..79bc39f42c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -20,14 +20,11 @@ body: attributes: label: Reproduction description: | - 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? + placeholder: | + A placeholder for the command. validations: required: true - type: textarea @@ -38,6 +35,8 @@ body: 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 @@ -45,10 +44,8 @@ body: label: Error traceback description: | If applicable, paste the error trackback here. - placeholder: | - ```none - A placeholder for trackback. - ``` + placeholder: Logs and traceback here. + render: Shell - type: markdown attributes: value: >