mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Polished issue template
This commit is contained in:
squidfunk
parent
78048312d6
commit
eb84c6957c
18
.github/ISSUE_TEMPLATE/bug.yml
vendored
18
.github/ISSUE_TEMPLATE/bug.yml
vendored
@ -4,7 +4,7 @@ body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Contribution guidelines
|
||||
description: Please read the contribution guidelines before proceeding
|
||||
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
|
||||
@ -15,31 +15,31 @@ body:
|
||||
options:
|
||||
- label: ... the problem doesn't occur with the `mkdocs` or `readthedocs` themes
|
||||
required: true
|
||||
- label: ... the problem persists, even when I remove all of my overrides (`custom_dir`, `extra_javascripts`, `extra_css`)
|
||||
- label: ... the problem persists when all overrides are removed, i.e. `custom_dir`, `extra_javascript` and `extra_css`
|
||||
- label: ... the documentation does not mention anything about my problem
|
||||
- label: ... there are no open or closed issues that are related to my problem
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: Please provide a brief description of the bug in 1-2 sentences
|
||||
description: Please provide a brief description of the bug in 1-2 sentences.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behaviour
|
||||
description: Please describe precisely what you'd expect to happen
|
||||
description: Please describe precisely what you'd expect to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual behaviour
|
||||
description: Please describe precisely what is actually happening
|
||||
description: Please describe precisely what is actually happening.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Please describe the steps to reproduce the bug
|
||||
description: Please describe the steps to reproduce the bug.
|
||||
placeholder: |-
|
||||
1. ...
|
||||
2. ...
|
||||
@ -49,7 +49,7 @@ body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Package versions
|
||||
description: Please provide all package versions (run the commands in backticks on a shell)
|
||||
description: Please provide all package versions, i.e. run the commands in backticks on a shell.
|
||||
value: |-
|
||||
- Python: `python --version`
|
||||
- MkDocs: `mkdocs --version`
|
||||
@ -59,7 +59,7 @@ body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Configuration
|
||||
description: Please provide a minimal (!) `mkdocs.yml` to reproduce the bug
|
||||
description: Please provide a minimal (!) `mkdocs.yml` to reproduce the bug.
|
||||
placeholder: |-
|
||||
site_name: My Docs
|
||||
site_url: https://example.com/docs
|
||||
@ -69,7 +69,7 @@ body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: System information
|
||||
description: Please provide your operating system and browser type and version
|
||||
description: Please provide your operating system and browser type and version.
|
||||
value: |-
|
||||
- Operating system: ...
|
||||
- Browser: ...
|
||||
|
||||
74
.github/ISSUE_TEMPLATE/feature.yml
vendored
74
.github/ISSUE_TEMPLATE/feature.yml
vendored
@ -1,48 +1,34 @@
|
||||
name: Feature
|
||||
description: Suggest an idea
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
### ⚠️ WARNING
|
||||
|
||||
Half of all issues created do not contain enough to help or are not appropriate for the issue tracker (i.e. one-line questions).
|
||||
If you would like to suggest a feature, follow the steps outlined below closely.
|
||||
Any issue that does not meet these conditions may be closed unnoticed.
|
||||
|
||||
Why? Because the maintainers of this project are wasting a lot of time answering questions that are not directly related to this project.
|
||||
If you have a question, please ask your question over in [Discussions](https://github.com/squidfunk/mkdocs-material/discussions), so other users can help you work towards a solution.
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Read and understand the Contributing guidelines
|
||||
description: You need to have read the contributing guidelines in order to proceed.
|
||||
options:
|
||||
- label: I've read the [contribution Guidelines](https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md) and agree with them
|
||||
- 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: 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, please 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 provide a breif description of the bug.
|
||||
placeholder: My feature would ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Use Cases
|
||||
description: Please describe how your suggestion would benefit you and other users.
|
||||
placeholder: My feature is beneficial because ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Screenshots / Mockups
|
||||
description: If applicable, provide some mockups or screenshots.
|
||||
placeholder: "https://i.imgur.com/cat.jpg"
|
||||
- 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.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user