refactor: 💡 Change checklist on issues templates to information

✅ Closes: #234
abelsiqueira · Jun 7, 2024 · 666511c · 666511c
1 parent 4fab3fd
commit 666511c
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 101 deletions.
diff --git 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
@@ -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
@@ -2,24 +2,23 @@ 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:
       label: Description
       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
@@ -1,22 +1,22 @@
 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:
       label: Description
       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
@@ -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/...github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/10-bug-report.yml.jinja b/...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/...b/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/20-feature-request.yml.jinja b/...b/{% 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/...ate/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/30-usage.yml.jinja b/...ate/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/30-usage.yml.jinja
@@ -2,24 +2,23 @@ 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:
       label: Description
       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/...e/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/99-general.yml.jinja b/...e/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}.jinja/99-general.yml.jinja
@@ -1,22 +1,22 @@
 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:
       label: Description
       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