diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 1abd75b74..a0677e3c1 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -11,11 +11,9 @@ body: you want to report, helping us to understand what you are working on and what you are trying to achieve. If the context is not relevant, you can leave this field empty. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context) - validations: - required: false - type: textarea - id: bug-description + id: description attributes: label: Bug description description: >- diff --git a/.github/ISSUE_TEMPLATE/change-request.yml b/.github/ISSUE_TEMPLATE/change-request.yml index c0156173f..7bf6dda67 100644 --- a/.github/ISSUE_TEMPLATE/change-request.yml +++ b/.github/ISSUE_TEMPLATE/change-request.yml @@ -68,6 +68,7 @@ body: Drag and drop images here or link external assets. - type: checkboxes + id: checklist attributes: label: Before submitting description: diff --git a/.github/ISSUE_TEMPLATE/docs-issue.yml b/.github/ISSUE_TEMPLATE/docs-issue.yml new file mode 100644 index 000000000..0c074175b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-issue.yml @@ -0,0 +1,62 @@ +name: Report a docs issue +description: Missing information in our docs? Create a documentation issue +labels: + - documentation + +body: + - type: textarea + id: description + attributes: + label: Description + description: >- + Please describe the inconsistency or issue you have found in the + [Material for MkDocs documentation](https://squidfunk.github.io/mkdocs-material) + or indicate where you feel there is a need for improvement. Furthermore, + explain the severity of the issue. + [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#description) + validations: + required: true + + - type: textarea + id: related-links + attributes: + label: Related links + description: >- + Please link the specific sections of [our documentation](https://squidfunk.github.io/mkdocs-material) + you described above. If applicable, add screenshots of this specific + section. + [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links) + value: |- + - [Reporting a docs issue](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/) + - + validations: + required: true + + - type: textarea + id: proposed-change + attributes: + label: Proposed change + description: >- + This field is optional. You may provide an improvement proposal for our + documentation by describing your suggestion in the text field below or + creating a pull request after reporting this issue containing the issue + number. + [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#proposed-change) + + - type: checkboxes + id: checklist + attributes: + label: Before submitting + description: >- + Please ensure your documentation issue report fulfills all of the + following requirements. If you need clarification on a specific + requirement, follow the link to learn about it and understand why it is + necessary before ticking the box. This will save the maintainers and you + valuable time. + options: + - label: >- + I have read and followed the [docs issue reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/). + required: true + - label: >- + I have attached the links to the described sections of [the documentation](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links) + required: true