From b54b35da4af6f3eb56f24cee3076d9d14e39421d Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Wed, 13 Nov 2024 16:50:49 +0000 Subject: [PATCH 1/5] Add simple issue template --- .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ .github/ISSUE_TEMPLATE/general.yml | 25 +++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/general.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..bd4d53ae7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false +contact_links: + - name: "Community Guidelines" + url: "https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md" + about: "Please make sure to follow the PSF Code of Conduct when participating in this repository." + diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml new file mode 100644 index 000000000..356520c15 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -0,0 +1,25 @@ +name: General Issue +description: Please fill out the form below to submit an issue. +labels: [] +assignees: [] + +body: + - type: textarea + id: issue_description + attributes: + label: "Issue Description" + description: "Please provide a detailed description of your issue." + placeholder: "Describe your issue here..." + value: "" + + - type: checkboxes + id: code_of_conduct + attributes: + label: Code of Conduct + description: | + **Please read the [PSF Code of Conduct][CoC] first.** + [CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md + options: + - label: "I am aware that participants in this repository must follow the PSF Code of Conduct." + required: true + From 17c228847d8b6fa87a70b36d94c5c99895fe7522 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Wed, 13 Nov 2024 16:57:42 +0000 Subject: [PATCH 2/5] Make issue description mandatory --- .github/ISSUE_TEMPLATE/general.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml index 356520c15..8d75b88ef 100644 --- a/.github/ISSUE_TEMPLATE/general.yml +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -11,6 +11,7 @@ body: description: "Please provide a detailed description of your issue." placeholder: "Describe your issue here..." value: "" + required: true - type: checkboxes id: code_of_conduct From 8869f451492cdd32b7e483fcca6df1eb6b9eb43d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 13 Nov 2024 17:04:09 +0000 Subject: [PATCH 3/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .github/ISSUE_TEMPLATE/config.yml | 1 - .github/ISSUE_TEMPLATE/general.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index bd4d53ae7..fbc581cd6 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,4 +3,3 @@ contact_links: - name: "Community Guidelines" url: "https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md" about: "Please make sure to follow the PSF Code of Conduct when participating in this repository." - diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml index 8d75b88ef..47fa75d7d 100644 --- a/.github/ISSUE_TEMPLATE/general.yml +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -23,4 +23,3 @@ body: options: - label: "I am aware that participants in this repository must follow the PSF Code of Conduct." required: true - From c4195ad83188f0259501e0439084a3dc8997ba23 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Wed, 13 Nov 2024 22:45:38 +0000 Subject: [PATCH 4/5] Implement suggestions from code review --- .github/ISSUE_TEMPLATE/general.yml | 32 ++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml index 47fa75d7d..4cfc57efb 100644 --- a/.github/ISSUE_TEMPLATE/general.yml +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -4,22 +4,34 @@ labels: [] assignees: [] body: + - type: markdown + attributes: + value: | + **Thanks for taking a minute to file an issue!** + + Read the [PSF Code of Conduct][CoC] first. + [CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md + + ⚠ + Verify first that your issue is not [already reported on + GitHub][issue search]. + + _Please fill out the form below with as many precise + details as possible._ + + [issue search]: ../search?q=is%3Aissue&type=issues + - type: textarea - id: issue_description attributes: - label: "Issue Description" - description: "Please provide a detailed description of your issue." - placeholder: "Describe your issue here..." - value: "" + label: Issue Description + description: Please provide a detailed description of your issue. + placeholder: Describe your issue here... + validations: required: true - type: checkboxes - id: code_of_conduct attributes: label: Code of Conduct - description: | - **Please read the [PSF Code of Conduct][CoC] first.** - [CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md options: - - label: "I am aware that participants in this repository must follow the PSF Code of Conduct." + - label: I am aware that participants in this repository must follow the PSF Code of Conduct. required: true From 3486a240d0e3e5235cc508284e430f69aff8de28 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Wed, 13 Nov 2024 22:46:50 +0000 Subject: [PATCH 5/5] Fix URL linking --- .github/ISSUE_TEMPLATE/general.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml index 4cfc57efb..d41731613 100644 --- a/.github/ISSUE_TEMPLATE/general.yml +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -10,7 +10,6 @@ body: **Thanks for taking a minute to file an issue!** Read the [PSF Code of Conduct][CoC] first. - [CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md ⚠ Verify first that your issue is not [already reported on @@ -19,6 +18,7 @@ body: _Please fill out the form below with as many precise details as possible._ + [CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md [issue search]: ../search?q=is%3Aissue&type=issues - type: textarea