1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-30 08:13:09 +01:00
mkdocs-material/.github/ISSUE_TEMPLATE/01-report-a-bug.yml

125 lines
5.4 KiB
YAML
Raw Normal View History

2023-01-02 11:54:01 +01:00
name: Report a bug
2023-01-29 19:22:11 +01:00
description: Something is not working? Report a bug
body:
2023-01-29 19:22:11 +01:00
2023-01-01 13:53:16 +01:00
- type: textarea
id: context
2021-06-29 10:50:49 +02:00
attributes:
2023-01-01 13:53:16 +01:00
label: Context
description: >-
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
2023-09-21 15:16:47 +02:00
leave this field empty.
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
2023-01-01 13:53:16 +01:00
2021-06-29 10:50:49 +02:00
- type: textarea
2023-01-29 19:26:21 +01:00
id: description
2021-06-29 10:50:49 +02:00
attributes:
2023-01-01 13:53:16 +01:00
label: Bug description
description: >-
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,
2023-09-21 15:16:47 +02:00
please let us maintainers (and all other users) know.
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
2021-06-29 10:50:49 +02:00
validations:
required: true
2023-01-01 13:53:16 +01:00
2021-06-29 10:50:49 +02:00
- type: textarea
2023-01-01 13:53:16 +01:00
id: related-links
2021-06-29 10:50:49 +02:00
attributes:
2023-01-01 13:53:16 +01:00
label: Related links
description: >-
Please list all links to the sections of
2023-09-21 15:16:47 +02:00
[our documentation](https://squidfunk.github.io/mkdocs-material/) that
2023-04-11 14:30:56 +02:00
are relevant to the bug in order to show that you have consulted and
2023-01-29 20:19:32 +01:00
thoroughly read it. Additionally, list links to possibly related open
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
2023-01-29 20:36:55 +01:00
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
2023-01-02 11:53:16 +01:00
you encountered when searching our issue tracker.
2023-01-29 19:22:11 +01:00
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#related-links)
2023-01-01 13:53:16 +01:00
value: |-
2023-01-29 19:22:11 +01:00
- [Reporting a bug](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/)
2023-01-01 13:53:16 +01:00
-
2021-06-29 10:50:49 +02:00
validations:
required: true
2023-01-01 13:53:16 +01:00
2021-06-29 10:50:49 +02:00
- type: textarea
2023-01-01 13:53:16 +01:00
id: reproduction
2021-06-29 10:50:49 +02:00
attributes:
2023-01-01 13:53:16 +01:00
label: Reproduction
description: >-
2023-01-12 22:29:33 +01:00
Please create a __.zip file__ with a __minimal reproduction__ for the
2023-02-07 10:27:20 +01:00
bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/)
2023-09-21 15:16:47 +02:00
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
2023-01-12 22:29:33 +01:00
.zip file with the reproduction. We reserve the right to close issues
2023-09-21 15:16:47 +02:00
without .zip files.
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
2023-01-01 13:53:16 +01:00
placeholder: |-
2023-09-21 15:16:47 +02:00
Drag and drop the .zip file with the minimal reproduction here.
2021-06-29 10:50:49 +02:00
validations:
required: true
2023-01-01 13:53:16 +01:00
2021-06-29 10:50:49 +02:00
- type: textarea
2023-01-01 13:53:16 +01:00
id: steps-to-reproduce
2021-06-29 10:50:49 +02:00
attributes:
label: Steps to reproduce
2023-01-01 13:53:16 +01:00
description: >-
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
2023-09-21 15:16:47 +02:00
verbose as necessary try not to leave anything out.
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
2021-06-29 10:50:49 +02:00
placeholder: |-
1. ...
2. ...
3. ...
validations:
required: true
2023-01-01 13:53:16 +01:00
- type: dropdown
id: browser
2021-06-29 10:50:49 +02:00
attributes:
2023-01-01 13:53:16 +01:00
label: Browser
description: >-
2023-09-21 15:28:46 +02:00
This field is optional. 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.
2023-09-21 15:16:47 +02:00
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
2023-01-01 13:53:16 +01:00
multiple: true
options:
- Chrome
- Safari
- Edge
- Firefox
- Opera
- Other
- type: checkboxes
id: checklist
2021-06-29 10:50:49 +02:00
attributes:
2023-01-01 13:53:16 +01:00
label: Before submitting
description: >-
Please ensure your bug report fulfills all of the following requirements.
If you are not sure what a specific requirement means, 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: >-
2023-01-29 19:22:11 +01:00
I have read and followed the [bug reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/).
2023-01-01 13:53:16 +01:00
required: true
- label: >-
2023-09-21 15:16:47 +02:00
I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material/),
2023-01-01 13:53:16 +01:00
and possibly related [issues](https://github.com/squidfunk/mkdocs-material/issues)
2023-01-29 19:22:11 +01:00
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions).
2023-01-01 13:53:16 +01:00
required: true
- label: >-
2023-01-29 19:22:11 +01:00
I assure that I have [removed all customizations](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#remove-customizations)
2023-01-01 13:53:16 +01:00
before submitting this bug report.
required: true
- label: >-
2024-03-02 04:47:19 +01:00
I have attached a __.zip file__ with a [minimal reproduction](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/) using the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/plugins/info/).
2023-01-01 13:53:16 +01:00
required: true