Skip to content

Commit 6368f32

Browse files
committed
Updated issue templates
1 parent 8188cfd commit 6368f32

File tree

3 files changed

+29
-24
lines changed

3 files changed

+29
-24
lines changed

.github/ISSUE_TEMPLATE/01-report-a-bug.yml

+14-9
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ body:
1010
This field is optional. You may provide additional context for the bug
1111
you want to report, helping us to understand what you are working on and
1212
what you are trying to achieve. If the context is not relevant, you can
13-
leave this field empty. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
13+
leave this field empty.
14+
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
1415
1516
- type: textarea
1617
id: description
@@ -20,7 +21,8 @@ body:
2021
Please give a detailed description of the bug. Explain where Material
2122
for MkDocs does not behave as you would expect it to. Be as specific as
2223
possible. If you have found a workaround or a fix for the problem,
23-
please let us maintainers (and all other users) know. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
24+
please let us maintainers (and all other users) know.
25+
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
2426
validations:
2527
required: true
2628

@@ -30,7 +32,7 @@ body:
3032
label: Related links
3133
description: >-
3234
Please list all links to the sections of
33-
[our documentation](https://squidfunk.github.io/mkdocs-material) that
35+
[our documentation](https://squidfunk.github.io/mkdocs-material/) that
3436
are relevant to the bug in order to show that you have consulted and
3537
thoroughly read it. Additionally, list links to possibly related open
3638
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
@@ -50,11 +52,12 @@ body:
5052
description: >-
5153
Please create a __.zip file__ with a __minimal reproduction__ for the
5254
bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/)
53-
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
55+
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
5456
.zip file with the reproduction. We reserve the right to close issues
55-
without .zip files. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
57+
without .zip files.
58+
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
5659
placeholder: |-
57-
Drag and drop the .zip file with minimal reproduction here.
60+
Drag and drop the .zip file with the minimal reproduction here.
5861
validations:
5962
required: true
6063

@@ -66,7 +69,8 @@ body:
6669
Please provide a detailed list of instructions, guiding us maintainers
6770
through the required steps, helping us to recreate the problem using the
6871
minimal reproduction you provided. Be as specific as possible and as
69-
verbose as necessary – try not to leave anything out. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
72+
verbose as necessary – try not to leave anything out.
73+
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
7074
placeholder: |-
7175
1. ...
7276
2. ...
@@ -82,7 +86,8 @@ body:
8286
If the bug only happens in __specific browsers__, please select them
8387
from the dropdown below. If your browser is not listed or the version
8488
is relevant, you may select _Other_ and provide more details in the
85-
field above. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
89+
field above.
90+
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
8691
multiple: true
8792
options:
8893
- Chrome
@@ -106,7 +111,7 @@ body:
106111
I have read and followed the [bug reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/).
107112
required: true
108113
- label: >-
109-
I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material),
114+
I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material/),
110115
and possibly related [issues](https://github.com/squidfunk/mkdocs-material/issues)
111116
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions).
112117
required: true

.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Report a docs issue
1+
name: Report a documentation issue
22
description: Missing information in our docs? Report a documentation issue
33
labels:
44
- documentation
@@ -10,7 +10,7 @@ body:
1010
label: Description
1111
description: >-
1212
Please describe the inconsistency or issue you have found in
13-
[our documentation](https://squidfunk.github.io/mkdocs-material)
13+
[our documentation](https://squidfunk.github.io/mkdocs-material/)
1414
or indicate where you feel there is a need for improvement. Furthermore,
1515
explain the severity of the issue, i.e., its impact on you and potentially
1616
other users.
@@ -23,7 +23,7 @@ body:
2323
attributes:
2424
label: Related links
2525
description: >-
26-
Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material)
26+
Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material/)
2727
that are impacted by the issue you described above. If applicable,
2828
add screenshots. Additionally, list links to possibly related open
2929
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
@@ -51,15 +51,15 @@ body:
5151
attributes:
5252
label: Before submitting
5353
description: >-
54-
Please ensure your documentation issue report fulfills all of the
55-
following requirements. If you need clarification on a specific
56-
requirement, follow the link to learn about it and understand why it is
57-
necessary before ticking the box. This will save the maintainers and you
54+
Please ensure your documentation issue fulfills all of the following
55+
requirements. If you need clarification on a specific requirement,
56+
follow the link to learn about it and understand why it is necessary
57+
before ticking the box. This will save the maintainers and you
5858
valuable time.
5959
options:
6060
- label: >-
61-
I have read and followed the [documentation issue reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
61+
I have read and followed the [documentation issue guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
6262
required: true
6363
- label: >-
64-
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)
64+
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)
6565
required: true

.github/ISSUE_TEMPLATE/03-request-a-change.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ body:
1010
This field is optional. You may provide additional context for the idea
1111
you want to propose, helping us to understand what you are working on
1212
and what you are trying to achieve. If the context is not relevant, you
13-
can leave this field empty. [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#context)
13+
can leave this field empty.
14+
[More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#context)
1415
1516
- type: textarea
1617
id: description
@@ -32,10 +33,9 @@ body:
3233
description: >-
3334
Please list all links to open and closed [issues](https://github.com/squidfunk/mkdocs-material/issues),
3435
[discussions](https://github.com/squidfunk/mkdocs-material/discussions),
35-
or to [documentation sections](https://squidfunk.github.io/mkdocs-material)
36-
that are relevant to your idea.
37-
If you discussed your idea with the community on our
38-
[discussion board](https://github.com/squidfunk/mkdocs-material/discussions)
36+
or to [documentation sections](https://squidfunk.github.io/mkdocs-material/)
37+
that are relevant to your idea. If you discussed your idea with the
38+
community on our [discussion board](https://github.com/squidfunk/mkdocs-material/discussions)
3939
prior to creating this change request, please link the discussion here as well.
4040
[More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#related-links)
4141
value: |-
@@ -90,6 +90,6 @@ body:
9090
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).
9191
required: true
9292
- label: >-
93-
I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues),
93+
I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material/), related [issues](https://github.com/squidfunk/mkdocs-material/issues),
9494
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
9595
required: true

0 commit comments

Comments
 (0)