From 7abe13122f419683b9e1e9491b66383a0e6f798a Mon Sep 17 00:00:00 2001 From: Tau Date: Sun, 23 Apr 2023 16:24:17 +0800 Subject: [PATCH 1/2] update issue template (#2291) --- .github/ISSUE_TEMPLATE/1-bug-report.yml | 107 +++++++++--------- .github/ISSUE_TEMPLATE/2-feature_request.yml | 32 +++--- .../ISSUE_TEMPLATE/3-general_questions.yml | 5 +- 3 files changed, 71 insertions(+), 73 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml index 23427231b8..c3682b9964 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -6,88 +6,87 @@ title: "[Bug] " body: - type: markdown attributes: - value: | - ## Note - For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmpose/discussions) - Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** + value: | + ## Note + For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmpose/discussions) + Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** - type: checkboxes attributes: - label: Prerequisite - description: Please check the following items before creating a new issue. - options: - - - label: I have searched [Issues](https://github.com/open-mmlab/mmpose/issues) and [Discussions](https://github.com/open-mmlab/mmpose/discussions) but cannot get the expected help. - required: true - - label: The bug has not been fixed in the latest version(https://github.com/open-mmlab/mmpose). - required: true + label: Prerequisite + description: Please check the following items before creating a new issue. + options: + - label: I have searched [Issues](https://github.com/open-mmlab/mmpose/issues) and [Discussions](https://github.com/open-mmlab/mmpose/discussions) but cannot get the expected help. + required: true + - label: The bug has not been fixed in the latest version(https://github.com/open-mmlab/mmpose). + required: true - type: textarea attributes: - label: Environment - description: | - Please run following commands and and copy-paste it here: - - `python -c "from mmpose.utils import collect_env; print(collect_env())"` to collect necessary environment information. - - `pip list | grep mm` to collect repositories related to OpenMMLab. - - \[Optional\] Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.) + label: Environment + description: | + Please run following commands and and copy-paste it here: + - `python -c "from mmpose.utils import collect_env; print(collect_env())"` to collect necessary environment information. + - `pip list | grep mm` to collect repositories related to OpenMMLab. + - \[Optional\] Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.) validations: - required: true + required: true - type: textarea attributes: - label: Reproduces the problem - code sample - description: | - Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet. - placeholder: | - ```python - # Sample code to reproduce the problem - ``` + label: Reproduces the problem - code sample + description: | + Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet. + placeholder: | + ```python + # Sample code to reproduce the problem + ``` validations: required: true - type: textarea attributes: - label: Reproduces the problem - command or script - description: | - What command or script did you run? - placeholder: | - ```shell - The command or script you run. - ``` + label: Reproduces the problem - command or script + description: | + What command or script did you run? + placeholder: | + ```shell + The command or script you run. + ``` validations: required: true - type: textarea attributes: - label: Reproduces the problem - error message - description: | - Please provide the error message or logs you got, with the full traceback. + label: Reproduces the problem - error message + description: | + Please provide the error message or logs you got, with the full traceback. - Tip: You can attach screenshots or log files by dragging them into the text area.. - placeholder: | - ``` - The error message or logs you got, with the full traceback. - ``` + Tip: You can attach screenshots or log files by dragging them into the text area.. + placeholder: | + ``` + The error message or logs you got, with the full traceback. + ``` validations: required: true - type: textarea attributes: - label: Additional information - description: | - Tell us anything else you think we should know. + label: Additional information + description: | + Tell us anything else you think we should know. - Tip: You can attach screenshots or log files by dragging them into the text area. - placeholder: | - 1. What's your expected result? - 2. What dataset did you use? - 3. What do you think might be the reason? + Tip: You can attach screenshots or log files by dragging them into the text area. + placeholder: | + 1. What's your expected result? + 2. What dataset did you use? + 3. What do you think might be the reason? - type: markdown attributes: - value: | - ## Acknowledgement - Thanks for taking the time to fill out this report. + value: | + ## Acknowledgement + Thanks for taking the time to fill out this report. - If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [**Here**](https://github.com/open-mmlab/mmpose/pulls)! - Please refer to [**Contribution Guide**](https://mmpose.readthedocs.io/en/latest/contribution_guide.html) for contributing. + If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [**Here**](https://github.com/open-mmlab/mmpose/pulls)! + Please refer to [**Contribution Guide**](https://mmpose.readthedocs.io/en/latest/contribution_guide.html) for contributing. diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml index 47247a0e17..fc726c89de 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yml @@ -6,32 +6,32 @@ title: "[Feature] " body: - type: markdown attributes: - value: | - ## Note - For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmpose/discussions) + value: | + ## Note + For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmpose/discussions) - Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** + Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** - type: textarea attributes: - label: What is the feature? - description: Tell us more about the feature and how this feature can help. - placeholder: | - E.g., It is inconvenient when \[....\]. + label: What is the feature? + description: Tell us more about the feature and how this feature can help. + placeholder: | + E.g., It is inconvenient when \[....\]. validations: required: true - type: textarea attributes: - label: Any other context? - description: | - Have you considered any alternative solutions or features? If so, what are they? Also, feel free to add any other context or screenshots about the feature request here. + label: Any other context? + description: | + Have you considered any alternative solutions or features? If so, what are they? Also, feel free to add any other context or screenshots about the feature request here. - type: markdown attributes: - value: | - ## Acknowledgement - Thanks for taking the time to fill out this report. + value: | + ## Acknowledgement + Thanks for taking the time to fill out this report. - We strongly appreciate you creating a new PR to implement it [**Here**](https://github.com/open-mmlab/mmpose/pulls)! - Please refer to [**Contribution Guide**](https://mmpose.readthedocs.io/en/latest/contribution_guide.html) for contributing. + We strongly appreciate you creating a new PR to implement it [**Here**](https://github.com/open-mmlab/mmpose/pulls)! + Please refer to [**Contribution Guide**](https://mmpose.readthedocs.io/en/latest/contribution_guide.html) for contributing. diff --git a/.github/ISSUE_TEMPLATE/3-general_questions.yml b/.github/ISSUE_TEMPLATE/3-general_questions.yml index 0b1194dc2e..d0ac0acabd 100644 --- a/.github/ISSUE_TEMPLATE/3-general_questions.yml +++ b/.github/ISSUE_TEMPLATE/3-general_questions.yml @@ -1,5 +1,4 @@ name: General questions about: Ask general questions to get help -title: '' -labels: '' -assignees: '' +labels: general-questions +title: "[Questions] " From 43397c334e9f6d78369ff2a31bed2f8c6059de36 Mon Sep 17 00:00:00 2001 From: Tau Date: Sun, 23 Apr 2023 16:42:27 +0800 Subject: [PATCH 2/2] fix issue template (#2292) --- .github/ISSUE_TEMPLATE/3-general_questions.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3-general_questions.yml b/.github/ISSUE_TEMPLATE/3-general_questions.yml index d0ac0acabd..b8ec58d2b1 100644 --- a/.github/ISSUE_TEMPLATE/3-general_questions.yml +++ b/.github/ISSUE_TEMPLATE/3-general_questions.yml @@ -1,4 +1,9 @@ -name: General questions -about: Ask general questions to get help +name: "📚 General questions" +description: "Ask general questions to get help" labels: general-questions title: "[Questions] " + +body: +- type: textarea + attributes: + label: "What's wrong?"