From 666511cbbac67ed4b5b23fa581de72598ad9591e Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Fri, 7 Jun 2024 13:37:07 +0200 Subject: [PATCH] =?UTF-8?q?refactor:=20=F0=9F=92=A1=20Change=20checklist?= =?UTF-8?q?=20on=20issues=20templates=20to=20information?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ✅ Closes: #234 --- .github/ISSUE_TEMPLATE/10-bug-report.yml | 20 ++++++-------- .github/ISSUE_TEMPLATE/20-feature-request.yml | 24 ++++++++--------- .github/ISSUE_TEMPLATE/30-usage.yml | 27 +++++++++---------- .github/ISSUE_TEMPLATE/99-general.yml | 24 ++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 2 +- .../10-bug-report.yml.jinja | 20 ++++++-------- .../20-feature-request.yml.jinja | 24 ++++++++--------- .../30-usage.yml.jinja | 27 +++++++++---------- .../99-general.yml.jinja | 24 ++++++++--------- 9 files changed, 91 insertions(+), 101 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/10-bug-report.yml b/.github/ISSUE_TEMPLATE/10-bug-report.yml index a32e48f0..38fa4141 100644 --- a/.github/ISSUE_TEMPLATE/10-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/10-bug-report.yml @@ -7,6 +7,14 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! + + Please, before submitting, make sure that: + + - There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) + - You are following the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you in filling out this issue. - type: textarea id: description attributes: @@ -51,15 +59,3 @@ body: - Windows - Linux - Mac - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) - required: true - - label: I agree with the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) - required: true diff --git a/.github/ISSUE_TEMPLATE/20-feature-request.yml b/.github/ISSUE_TEMPLATE/20-feature-request.yml index 8f69634b..7ac6abdc 100644 --- a/.github/ISSUE_TEMPLATE/20-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/20-feature-request.yml @@ -1,6 +1,18 @@ name: "Feature Request" description: Suggest a new feature for the package body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please, before submitting, make sure that: + + - There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) + - You are following the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you in filling out this issue. - type: textarea id: description attributes: @@ -23,15 +35,3 @@ body: attributes: label: Can you help description: Can you help developing this feature? - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) - required: true - - label: I agree with the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) - required: true diff --git a/.github/ISSUE_TEMPLATE/30-usage.yml b/.github/ISSUE_TEMPLATE/30-usage.yml index e9906dc1..6ce842a4 100644 --- a/.github/ISSUE_TEMPLATE/30-usage.yml +++ b/.github/ISSUE_TEMPLATE/30-usage.yml @@ -2,6 +2,19 @@ name: "Usage question" description: Questions related to the usage labels: ["usage docs"] body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please, before submitting, make sure that: + + - You have checked the [documentation](https://abelsiqueira.github.io/COPIERTemplate.jl) and haven't found enough information + - There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) + - You are following the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you in filling out this issue. - type: textarea id: description attributes: @@ -9,17 +22,3 @@ body: description: Write your question validations: required: true - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: I have checked the [documentation](https://abelsiqueira.github.io/COPIERTemplate.jl) and haven't found enough information - required: true - - label: There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) - required: true - - label: I agree with the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) - required: true diff --git a/.github/ISSUE_TEMPLATE/99-general.yml b/.github/ISSUE_TEMPLATE/99-general.yml index f64d0fc9..a705e3e3 100644 --- a/.github/ISSUE_TEMPLATE/99-general.yml +++ b/.github/ISSUE_TEMPLATE/99-general.yml @@ -1,6 +1,18 @@ name: "General issue" description: In case none of the others templates apply body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please, before submitting, make sure that: + + - There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) + - You are following the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you filling out this issue. - type: textarea id: description attributes: @@ -8,15 +20,3 @@ body: description: Describe the issue validations: required: true - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: There is not an [existing issue](https://github.com/abelsiqueira/COPIERTemplate.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/docs/src/90-contributing.md) - required: true - - label: I agree with the [code of conduct](https://github.com/abelsiqueira/COPIERTemplates.jl/blob/main/CODE_OF_CONDUCT.md) - required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 65bb6d2f..a0b2bd17 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: Discussions url: https://github.com/abelsiqueira/COPIERTemplate.jl/discussions diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/10-bug-report.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/10-bug-report.yml.jinja index 213f2001..5a0a7b3a 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/10-bug-report.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/10-bug-report.yml.jinja @@ -7,6 +7,14 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! + + Please, before submitting make sure that: + + - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you in filling out this issue. - type: textarea id: description attributes: @@ -51,15 +59,3 @@ body: - Windows - Linux - Mac - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) - required: true - - label: I agree with the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) - required: true diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/20-feature-request.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/20-feature-request.yml.jinja index 8a65dcd1..dd762c74 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/20-feature-request.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/20-feature-request.yml.jinja @@ -1,6 +1,18 @@ name: "Feature Request" description: Suggest a new feature for the package body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please, before submitting make sure that: + + - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you in filling out this issue. - type: textarea id: description attributes: @@ -23,15 +35,3 @@ body: attributes: label: Can you help description: Can you help developing this feature? - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) - required: true - - label: I agree with the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) - required: true diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/30-usage.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/30-usage.yml.jinja index e7ec2108..54683c20 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/30-usage.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/30-usage.yml.jinja @@ -2,6 +2,19 @@ name: "Usage question" description: Questions related to the usage labels: ["documentation"] body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please, before submitting make sure that: + + - You have checked the [documentation](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl) and haven't found enough information + - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you in filling out this issue. - type: textarea id: description attributes: @@ -9,17 +22,3 @@ body: description: Write your question validations: required: true - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: I have checked the [documentation](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl) and haven't found enough information - required: true - - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) - required: true - - label: I agree with the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) - required: true diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/99-general.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/99-general.yml.jinja index 92765633..9a14d14f 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/99-general.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/99-general.yml.jinja @@ -1,6 +1,18 @@ name: "General issue" description: In case none of the others templates apply body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please, before submitting make sure that: + + - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question + - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You follow the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) + + The form below should help you in filling out this issue. - type: textarea id: description attributes: @@ -8,15 +20,3 @@ body: description: Describe the issue validations: required: true - - type: checkboxes - id: checks - attributes: - label: Checks - description: Confirm the following, please - options: - - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - required: true - - label: I have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) - required: true - - label: I agree with the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) - required: true