1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-23 21:04:56 +01:00
mkdocs-material/.github/ISSUE_TEMPLATE/03-request-a-change.yml
2023-09-21 15:16:47 +02:00

96 lines
4.5 KiB
YAML

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 the
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
- type: textarea
id: related-links
attributes:
label: Related links
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)
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/)
-
validations:
required: true
- type: textarea
id: use-cases
attributes:
label: Use Cases
description: >-
Please explain how your idea will work from an author's and user's
perspective. Elaborate on how the change would positively impact not only
you but our community and how it aligns with the goals and [philosophy](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
- 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 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.
- type: checkboxes
id: checklist
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 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),
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
required: true