From 66cdb6ab7d074551743247f19b45f0fbdbcf4941 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 29 Jan 2023 20:18:49 +0100 Subject: [PATCH] Updated issue templates --- .../{bug.yml => 01-report-a-bug.yml} | 2 ++ ...s-issue.yml => 02-report-a-docs-issue.yml} | 2 +- ...ge-request.yml => 03-request-a-change.yml} | 19 ++++++++++++------- ...translate.yml => 04-add-a-translation.yml} | 5 ++++- .github/ISSUE_TEMPLATE/config.yml | 2 +- 5 files changed, 20 insertions(+), 10 deletions(-) rename .github/ISSUE_TEMPLATE/{bug.yml => 01-report-a-bug.yml} (99%) rename .github/ISSUE_TEMPLATE/{docs-issue.yml => 02-report-a-docs-issue.yml} (100%) rename .github/ISSUE_TEMPLATE/{change-request.yml => 03-request-a-change.yml} (83%) rename .github/ISSUE_TEMPLATE/{translate.yml => 04-add-a-translation.yml} (98%) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml similarity index 99% rename from .github/ISSUE_TEMPLATE/bug.yml rename to .github/ISSUE_TEMPLATE/01-report-a-bug.yml index a0677e3c1..d8a2d145e 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml @@ -1,5 +1,7 @@ name: Report a bug description: Something is not working? Report a bug +labels: + - needs investigation body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/docs-issue.yml b/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/docs-issue.yml rename to .github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml index 0c074175b..57395ddb7 100644 --- a/.github/ISSUE_TEMPLATE/docs-issue.yml +++ b/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml @@ -2,8 +2,8 @@ name: Report a docs issue description: Missing information in our docs? Create a documentation issue labels: - documentation - body: + - type: textarea id: description attributes: diff --git a/.github/ISSUE_TEMPLATE/change-request.yml b/.github/ISSUE_TEMPLATE/03-request-a-change.yml similarity index 83% rename from .github/ISSUE_TEMPLATE/change-request.yml rename to .github/ISSUE_TEMPLATE/03-request-a-change.yml index 7bf6dda67..edc5196ba 100644 --- a/.github/ISSUE_TEMPLATE/change-request.yml +++ b/.github/ISSUE_TEMPLATE/03-request-a-change.yml @@ -1,5 +1,7 @@ name: Request a change description: Want to submit an idea? Propose a change or feature request +labels: + - needs investigation body: - type: textarea @@ -19,7 +21,8 @@ body: description: >- Please provide a detailed description of your idea in 2-3 sentences, so that we maintainers can fully understand what change, feature, or - improvement you are proposing. + improvement you are proposing. Don't yet explain the benefits of your + idea, we'll come to that. Focus on functionality. [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#description) validations: required: true @@ -29,13 +32,13 @@ body: attributes: label: Related links description: >- - Please list all links to [issues](https://github.com/squidfunk/mkdocs-material/issues), + Please list all links to open and closed [issues](https://github.com/squidfunk/mkdocs-material/issues), [discussions](https://github.com/squidfunk/mkdocs-material/discussions) or to [documentation sections](https://squidfunk.github.io/mkdocs-material) that are relevant to your idea. If you discussed your idea with the community on our - [discussion board](https://github.com/squidfunk/mkdocs-material/discussions), - please link it here as well. + [discussion board](https://github.com/squidfunk/mkdocs-material/discussions) + prior to creating this change request, please link the discussion here as well. [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#related-links) value: |- - [Requesting a change](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/) @@ -48,8 +51,10 @@ body: attributes: label: Use Cases description: >- - Please explain how your idea will be used by yourself and the community, - as well as the benefits it brings. + Please explain how your idea will work from an author's and user's + perspective. Elaborate how the change would positively impact not only + you, but the community, and how it aligns with the goals and [philopsophy](https://squidfunk.github.io/mkdocs-material/philosophy/) + of the project. [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#use-cases) validations: required: true @@ -62,7 +67,7 @@ body: This field is optional. You may provide sketches, screenshots, mockups, or external assets to illustrate your idea. If you have seen this change, feature, or improvement used in other static site generators or themes, - please describe how it was used and incorporated. + please describe how it is implemented and advertised. [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#visuals) placeholder: |- Drag and drop images here or link external assets. diff --git a/.github/ISSUE_TEMPLATE/translate.yml b/.github/ISSUE_TEMPLATE/04-add-a-translation.yml similarity index 98% rename from .github/ISSUE_TEMPLATE/translate.yml rename to .github/ISSUE_TEMPLATE/04-add-a-translation.yml index 28d01b51e..6232940be 100644 --- a/.github/ISSUE_TEMPLATE/translate.yml +++ b/.github/ISSUE_TEMPLATE/04-add-a-translation.yml @@ -1,6 +1,9 @@ -name: Translate +name: Add a translation description: Add localization for a new language title: 'New language: {replace with language name}' +labels: + - enhancement + body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 38dcea254..43c226a6e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -22,4 +22,4 @@ blank_issues_enabled: false contact_links: - name: Ask a question url: https://github.com/squidfunk/mkdocs-material/discussions - about: Have a question or need help? Ask your question on our discussion board + about: Have a question or need help? Connect with the community on our discussion board