From 04af0e1e3bae818e3ae27be02afc9891bcd1a8e5 Mon Sep 17 00:00:00 2001 From: Don Turner Date: Fri, 29 Jul 2022 14:27:49 +0100 Subject: [PATCH] Adding github issue template for documentation issues --- .github/ISSUE_TEMPLATE/docs_issue.yml | 38 +++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/docs_issue.yml diff --git a/.github/ISSUE_TEMPLATE/docs_issue.yml b/.github/ISSUE_TEMPLATE/docs_issue.yml new file mode 100644 index 000000000..0a925e2f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_issue.yml @@ -0,0 +1,38 @@ +name: Documentation issue +description: File an issue or make a suggestion for the project documentation +title: "[Documentation]: " +labels: ["documentation"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to improve our documentation! + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the documentation issue you encountered. + options: + - label: I have searched the existing issues + required: true + - type: input + id: page-url + attributes: + label: Page URL (type "NEW" for a new page suggestion) + validations: + required: true + - type: textarea + id: what-needs-improving + attributes: + label: What's the documentation problem or suggestion? + placeholder: Tell us what should be improved! + value: "Docs need improving!" + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true