diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9a15fc6e7..b188c0d36 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,20 +1,16 @@ -# Pull Request contents - -## Link to issue +#### Link to issue Please add a link to the issue being addressed by this change. -## Description +#### Description + +Please include a short description of the suggested change and the reasoning behind the approach you have chosen. -Please include a short description of the suggested change and the reasoning -behind the approach you have chosen. +#### Screenshot of the result -## Screenshot of the result +If your change affects the user interface you should include a screenshot of the result with the pull request. -If your change affects the user interface you should include a screenshot of -the result with the pull request. +#### Additional comments or questions -## Additional comments or questions +If you have any further comments or questions for the reviewer them please add them here. -If you have any further comments or questions for the reviewer them please add -them here. diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index bd3731cca..78999bcc7 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -1,8 +1,9 @@ globs: - - './**/*.{md,markdown}' + - "./**/*.{md,markdown}" ignores: - node_modules + - "./.github/**/*" config: MD033: