From 8ee737fdadf2845d7e2a79122cf8929260ce7011 Mon Sep 17 00:00:00 2001 From: James Bromwell <943160+thw0rted@users.noreply.github.com> Date: Wed, 23 Aug 2023 18:49:11 -0400 Subject: [PATCH 1/2] First pass at documentation.yaml --- .github/ISSUE_TEMPLATE/documentation.yaml | 30 +++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 000000000000..d7e63b34b018 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,30 @@ +name: Documentation 📖 +description: Submit a request to add or update documentation +title: '[Docs]: ' +labels: ['Documentation :book:'] +body: + - type: markdown + attributes: + value: | + ### Thank you for helping us improve our documentation! + + Please be sure you are looking at [the latest version of the documentation](https://jestjs.io/docs/expect) before opening an issue here. + - type: textarea + id: links + attributes: + label: Page(s) + description: | + Links to one or more documentation pages that should be modified. + If you are reporting an issue with a specific section of a page, try to link directly to the nearest anchor. + If you are suggesting that a new page be created, link to the parent of the proposed page. + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: | + Describe the change you are requesting. + If the issue pertains to a single function or matcher, be sure to specify the entire call signature. + validations: + required: true From 9915130ed81a052034b3f865bafde5fbdc623247 Mon Sep 17 00:00:00 2001 From: James Bromwell <943160+thw0rted@users.noreply.github.com> Date: Wed, 23 Aug 2023 18:53:21 -0400 Subject: [PATCH 2/2] Fix docs link Didn't mean to link to a sub-page of the docs --- .github/ISSUE_TEMPLATE/documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml index d7e63b34b018..5532452ffc82 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yaml +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -8,7 +8,7 @@ body: value: | ### Thank you for helping us improve our documentation! - Please be sure you are looking at [the latest version of the documentation](https://jestjs.io/docs/expect) before opening an issue here. + Please be sure you are looking at [the latest version of the documentation](https://jestjs.io/docs) before opening an issue here. - type: textarea id: links attributes: