From c727cf9d35b0c7137751a861a0f951dea8a64bb3 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Tue, 12 Dec 2023 12:42:35 -0500 Subject: [PATCH] issue-template-docs --- .github/ISSUE_TEMPLATE/change.yml | 2 +- .github/ISSUE_TEMPLATE/docs.yml | 46 +++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/docs.yml diff --git a/.github/ISSUE_TEMPLATE/change.yml b/.github/ISSUE_TEMPLATE/change.yml index c7a21127eba2..105332d8b51c 100644 --- a/.github/ISSUE_TEMPLATE/change.yml +++ b/.github/ISSUE_TEMPLATE/change.yml @@ -1,4 +1,4 @@ -name: "\U0001F4DD Request a change (not rule-related)" +name: "\U00010024 Request a change (not rule-related)" description: "Request a change that is not a bug fix, rule change, or new rule" title: "Change Request: (fill in)" labels: diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 000000000000..d2961e62167a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,46 @@ +name: "\U0001F4DD Docs" +description: "Request an improvement to documentation" +title: "Docs: (fill in)" +labels: + - documentation +body: +- type: markdown + attributes: + value: By opening an issue, you agree to abide by the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). +- type: input + attributes: + label: Docs page(s) + description: | + What page(s) are you looking at? + placeholder: | + e.g. https://eslint.org/docs/latest/use/getting-started + validations: + required: true +- type: textarea + attributes: + label: What documentation issue do you want to solve? + description: | + Please explain your use case in as much detail as possible. + placeholder: | + The ESLint docs currently... + validations: + required: true +- type: textarea + attributes: + label: What do you think is the correct solution? + description: | + Please explain how you'd like to change the ESLint docs to address the problem. + placeholder: | + I'd like the ESLint docs to... + validations: + required: true +- type: checkboxes + attributes: + label: Participation + options: + - label: I am willing to submit a pull request for this change. + required: false +- type: textarea + attributes: + label: Additional comments + description: Is there anything else that's important for the team to know?