mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-28 01:10:58 +01:00
Updated issue templates
This commit is contained in:
squidfunk
parent
8188cfdbd0
commit
6368f324d3
23
.github/ISSUE_TEMPLATE/01-report-a-bug.yml
vendored
23
.github/ISSUE_TEMPLATE/01-report-a-bug.yml
vendored
@ -10,7 +10,8 @@ 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/contributing/reporting-a-bug/#context)
|
||||
leave this field empty.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
@ -20,7 +21,8 @@ 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/contributing/reporting-a-bug/#bug-description)
|
||||
please let us maintainers (and all other users) know.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
@ -30,7 +32,7 @@ body:
|
||||
label: Related links
|
||||
description: >-
|
||||
Please list all links to the sections of
|
||||
[our documentation](https://squidfunk.github.io/mkdocs-material) that
|
||||
[our documentation](https://squidfunk.github.io/mkdocs-material/) that
|
||||
are relevant to the bug in order to show that you have consulted and
|
||||
thoroughly read it. Additionally, list links to possibly related open
|
||||
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
|
||||
@ -50,11 +52,12 @@ body:
|
||||
description: >-
|
||||
Please create a __.zip file__ with a __minimal reproduction__ for the
|
||||
bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/)
|
||||
that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/#creating-a-zip-file) (mandatory) to create a self-contained
|
||||
that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/plugins/info/) (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/contributing/reporting-a-bug/#reproduction)
|
||||
without .zip files.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
|
||||
placeholder: |-
|
||||
Drag and drop the .zip file with minimal reproduction here.
|
||||
Drag and drop the .zip file with the minimal reproduction here.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
@ -66,7 +69,8 @@ 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/contributing/reporting-a-bug/#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. ...
|
||||
@ -82,7 +86,8 @@ 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/contributing/reporting-a-bug/#browser)
|
||||
field above.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
|
||||
multiple: true
|
||||
options:
|
||||
- Chrome
|
||||
@ -106,7 +111,7 @@ body:
|
||||
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),
|
||||
I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material/),
|
||||
and possibly related [issues](https://github.com/squidfunk/mkdocs-material/issues)
|
||||
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions).
|
||||
required: true
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
name: Report a docs issue
|
||||
name: Report a documentation issue
|
||||
description: Missing information in our docs? Report a documentation issue
|
||||
labels:
|
||||
- documentation
|
||||
@ -10,7 +10,7 @@ body:
|
||||
label: Description
|
||||
description: >-
|
||||
Please describe the inconsistency or issue you have found in
|
||||
[our documentation](https://squidfunk.github.io/mkdocs-material)
|
||||
[our 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, i.e., its impact on you and potentially
|
||||
other users.
|
||||
@ -23,7 +23,7 @@ body:
|
||||
attributes:
|
||||
label: Related links
|
||||
description: >-
|
||||
Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material)
|
||||
Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material/)
|
||||
that are impacted by the issue you described above. If applicable,
|
||||
add screenshots. Additionally, list links to possibly related open
|
||||
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
|
||||
@ -51,15 +51,15 @@ body:
|
||||
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
|
||||
Please ensure your documentation issue 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 [documentation issue reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
|
||||
I have read and followed the [documentation issue 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)
|
||||
I have attached the links to the affected sections of [the documentation](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links)
|
||||
required: true
|
||||
|
||||
12
.github/ISSUE_TEMPLATE/03-request-a-change.yml
vendored
12
.github/ISSUE_TEMPLATE/03-request-a-change.yml
vendored
@ -10,7 +10,8 @@ body:
|
||||
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)
|
||||
can leave this field empty.
|
||||
[More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#context)
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
@ -32,10 +33,9 @@ body:
|
||||
description: >-
|
||||
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)
|
||||
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)
|
||||
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: |-
|
||||
@ -90,6 +90,6 @@ body:
|
||||
I have ensured that, to the best of my 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),
|
||||
I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material/), related [issues](https://github.com/squidfunk/mkdocs-material/issues),
|
||||
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
|
||||
required: true
|
||||
|
||||
Loading…
Reference in New Issue
Block a user