From 081362558c5b310cf1660d3a5b5a2debb15195d2 Mon Sep 17 00:00:00 2001 From: Tierney Cyren Date: Wed, 26 Jan 2022 13:21:14 -0500 Subject: [PATCH] chore: add docs issue templates (#4321) --- .github/ISSUE_TEMPLATE/docs-enhancement.yml | 37 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/docs-problem.yml | 37 +++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/docs-enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/docs-problem.yml diff --git a/.github/ISSUE_TEMPLATE/docs-enhancement.yml b/.github/ISSUE_TEMPLATE/docs-enhancement.yml new file mode 100644 index 0000000000000..ee8db1e8841d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-enhancement.yml @@ -0,0 +1,37 @@ +name: 📄 CLI Docs Enhancement +description: File a potential enhancement for the npm documentation +title: "[DOCS] " +labels: [Documentation, Needs Triage] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please [search here](https://github.com/npm/cli/issues) to see if an issue already exists for your problem. + options: + - label: I have searched the existing issues + required: true +- type: checkboxes + attributes: + label: This is a CLI Docs Enhancement, not another kind of Docs Enhancement. + description: These issue templates are only for CLI documentation enhancements. If you are looking to submit another kind of documentation enhancement, please submit it to the [documentation](https://github.com/npm/documentation) repo. + options: + - label: This is a CLI Docs Enhancement. + required: true +- type: textarea + attributes: + label: Description of Problem + description: A clear & concise description of the current state of the docs. + validations: + required: true +- type: textarea + attributes: + label: Potential Solution + description: A clear & concise description of the potential enhancement, if there is one. + validations: + required: false +- type: input + attributes: + label: Docs URL + description: Please provide the URL of the page you'd like to see an enhancement to. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/docs-problem.yml b/.github/ISSUE_TEMPLATE/docs-problem.yml new file mode 100644 index 0000000000000..6d509680979cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-problem.yml @@ -0,0 +1,37 @@ +name: 📄 CLI Docs Problem +description: File a problem with the npm documentation +title: "[DOCS] <title>" +labels: [Documentation, Needs Triage] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please [search here](https://github.com/npm/cli/issues) to see if an issue already exists for your problem. + options: + - label: I have searched the existing issues + required: true +- type: checkboxes + attributes: + label: This is a CLI Docs Problem, not another kind of Docs Problem. + description: These issue templates are only for CLI documentation problems. If you are looking to submit another kind of documentation problem, please submit it to the [documentation](https://github.com/npm/documentation) repo. + options: + - label: This is a CLI Docs Problem. + required: true +- type: textarea + attributes: + label: Description of Problem + description: A clear & concise description of what is wrong with the docs. + validations: + required: true +- type: textarea + attributes: + label: Potential Solution + description: A clear & concise description of a potential solution or fix to the problem, if there is one. + validations: + required: false +- type: input + attributes: + label: Affected URL + description: Please provide the affected URL. + validations: + required: false