Updated issue templates

2024-06-14 11:52:32 +03:00 · 2023-01-29 19:22:11 +01:00 · 2023-01-29 19:22:11 +01:00 · 97573c0ae4
commit 97573c0ae4
parent 87fed7ec2e
3 changed files with 106 additions and 49 deletions
--- a/.github/ISSUE_TEMPLATE/bug.yml
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@ -1,7 +1,7 @@
 name: Report a bug
-description: Something is not working? Report a bug in Material for MkDocs.
-
+description: Something is not working? Report a bug
 body:
+
  - type: textarea
    id: context
    attributes:
@ -10,7 +10,7 @@ body:
        This field is optional. You may provide additional context for the bug
        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/bug-report/#context)
+        leave this field empty. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
    validations:
      required: false

@ -22,7 +22,7 @@ body:
        Please give a detailed description of the bug. Explain where Material
        for MkDocs does not behave as you would expect it to. Be as specific as
        possible. If you have found a workaround or a fix for the problem,
-        please let us maintainers (and all other users) know. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#bug-description)
+        please let us maintainers (and all other users) know. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#description)
    validations:
      required: true

@ -38,9 +38,9 @@ body:
        [issues](https://github.com/squidfunk/mkdocs-material/issues)
        or [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
        you encountered when searching our issue tracker.
-        [More](https://squidfunk.github.io/mkdocs-material/bug-report/#related-links)
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#related-links)
      value: |-
-        - [Bug reporting](https://squidfunk.github.io/mkdocs-material/bug-report/)
+        - [Reporting a bug](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/)
        -
    validations:
      required: true
@ -51,10 +51,10 @@ body:
      label: Reproduction
      description: >-
        Please create a __.zip file__ with a __minimal reproduction__ for the
-        bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/)
-        that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/#creating-a-zip-file) (mandatory) to create a self-contained
+        bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/reproduction/)
+        that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/reproduction/#creating-a-zip-file) (mandatory) to create a self-contained
        .zip file with the reproduction. We reserve the right to close issues
-        without .zip files. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#reproduction)
+        without .zip files. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
      placeholder: |-
        Drag and drop .zip file with minimal reproduction here.
    validations:
@ -68,7 +68,7 @@ body:
        Please provide a detailed list of instructions, guiding us maintainers
        through the required steps, helping us to recreate the problem using the
        minimal reproduction you provided. Be as specific as possible and as
-        verbose as necessary – try not to leave anything out. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#steps-to-reproduce)
+        verbose as necessary – try not to leave anything out. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
      placeholder: |-
        1. ...
        2. ...
@ -84,7 +84,7 @@ body:
        If the bug only happens in __specific browsers__, please select them
        from the dropdown below. If your browser is not listed or the version
        is relevant, you may select _Other_ and provide more details in the
-        field above. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#browser)
+        field above. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
      multiple: true
      options:
        - Chrome
@ -105,17 +105,17 @@ body:
        box. This will save the maintainers and you valuable time.
      options:
        - label: >-
-            I have read and followed the [bug reporting guidelines](https://squidfunk.github.io/mkdocs-material/bug-report/).
+            I have read and followed the [bug reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/).
          required: true
        - label: >-
            I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material),
            and possibly related [issues](https://github.com/squidfunk/mkdocs-material/issues)
-            or [discussions](https://github.com/squidfunk/mkdocs-material/discussions).
+            and [discussions](https://github.com/squidfunk/mkdocs-material/discussions).
          required: true
        - label: >-
-            I assure that I have [removed all customizations](https://squidfunk.github.io/mkdocs-material/bug-report/#remove-customizations)
+            I assure that I have [removed all customizations](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#remove-customizations)
            before submitting this bug report.
          required: true
        - label: >-
-            I have attached a __.zip file__ with a [minimal reproduction](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/).
+            I have attached a __.zip file__ with a [minimal reproduction](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/reproduction/).
          required: true
--- a/.github/ISSUE_TEMPLATE/change-request.yml
+++ b/.github/ISSUE_TEMPLATE/change-request.yml
@ -0,0 +1,91 @@
+name: Request a change
+description: Want to submit an idea? Propose a change or feature request
+body:
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Context
+      description: >-
+        This field is optional. You may provide additional context for the idea
+        you want to propose, 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/requesting-a-change/#context)
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      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.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#description)
+    validations:
+      required: true
+
+  - type: textarea
+    id: related-links
+    attributes:
+      label: Related links
+      description: >-
+        Please list all links to [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.
+        [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/)
+        -
+    validations:
+      required: true
+
+  - type: textarea
+    id: use-cases
+    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.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#use-cases)
+    validations:
+      required: true
+
+  - type: textarea
+    id: visuals
+    attributes:
+      label: Visuals
+      description: >-
+        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.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#visuals)
+      placeholder: |-
+        Drag and drop images here or link external assets.
+
+  - type: checkboxes
+    attributes:
+      label: Before submitting
+      description:
+        Please ensure your idea 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 [change request guidelines](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/).
+        required: true
+      - label: >-
+            I have verified that [my idea is a change request and not a bug report](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#its-not-a-bug-its-a-feature).
+        required: true
+      - label: >-
+            I have ensured that, to the best knowledge, [my idea will benefit the entire community](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community).
+        required: true
+      - label: >-
+            I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues)
+            or [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
+        required: true
--- a/.github/ISSUE_TEMPLATE/feature.yml
+++ b/.github/ISSUE_TEMPLATE/feature.yml
@ -1,34 +0,0 @@
-name: Feature
-description: Suggest an idea
-body:
-  - type: checkboxes
-    attributes:
-      label: Contribution guidelines
-      description: Please read the contribution guidelines before proceeding.
-      options:
-        - label: I've read the [contribution guidelines](https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md) and wholeheartedly agree
-          required: true
-  - type: checkboxes
-    attributes:
-      label: I want to suggest an idea and checked that ...
-      description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why.
-      options:
-      - label: ... to my best knowledge, my idea wouldn't break something for other users
-      - label: ... the documentation does not mention anything about my idea
-      - label: ... there are no open or closed issues that are related to my idea
-  - type: textarea
-    attributes:
-      label: Description
-      description: Please describe your idea in a reasonable amount of detail.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Use Cases
-      description: Please describe how your idea would benefit you and other users.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Screenshots / Mockups
-      description: If applicable, provide mockups or screenshots. You can drag-and-drop images here, or link to external assets.