mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-28 01:10:58 +01:00
Revamped issue templates
This commit is contained in:
squidfunk
parent
3ec9506651
commit
5b25813d6c
34
.github/ISSUE_TEMPLATE.md
vendored
34
.github/ISSUE_TEMPLATE.md
vendored
@ -1,34 +0,0 @@
|
||||
## Description
|
||||
|
||||
[Description of the bug]
|
||||
|
||||
### Expected behavior
|
||||
|
||||
[What you expected to happen]
|
||||
|
||||
### Actual behavior
|
||||
|
||||
[What is actually happening]
|
||||
|
||||
### Steps to reproduce the bug
|
||||
|
||||
1. [First step]
|
||||
2. [Second step]
|
||||
3. [and so on...]
|
||||
|
||||
### Package versions
|
||||
|
||||
* Python: `python --version`
|
||||
* MkDocs: `mkdocs --version`
|
||||
* Material: `pip show mkdocs-material | grep -E ^Version`
|
||||
|
||||
### Project configuration
|
||||
|
||||
``` yaml
|
||||
The contents of your mkdocs.yml
|
||||
```
|
||||
|
||||
### System information
|
||||
|
||||
* OS: [The operating system you're running]
|
||||
* Browser: [The browser used, if relevant]
|
||||
70
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal file
70
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
name: Bug
|
||||
about: Report a bug
|
||||
---
|
||||
|
||||
<!--
|
||||
⚠️ WARNING
|
||||
|
||||
Half of all issues created do not contain enough information to help or are
|
||||
not appropriate for the issue tracker (i.e. one-line questions). If you think
|
||||
you found a bug, 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.
|
||||
-->
|
||||
|
||||
__Checklist__:
|
||||
|
||||
<!-- Make sure that your request fulfills all of the following requirements -->
|
||||
|
||||
I checked that...
|
||||
|
||||
- [ ] ... the documentation does not mention anything about my problem
|
||||
- [ ] ... the problem doesn't occur with the default MkDocs template
|
||||
- [ ] ... the problem is not in any of my customizations (CSS, JS, template)
|
||||
- [ ] ... there are no open or closed issues that are related to my problem
|
||||
|
||||
## Description
|
||||
|
||||
<!-- Please provide a brief description of the bug -->
|
||||
|
||||
### Expected behavior
|
||||
|
||||
<!-- Please describe what you expected to happen -->
|
||||
|
||||
### Actual behavior
|
||||
|
||||
<!-- Please describe what is actually happening -->
|
||||
|
||||
### Steps to reproduce the bug
|
||||
|
||||
<!-- Please provide the steps to repoduce the issue -->
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
### Package versions
|
||||
|
||||
<!-- Please provide all package versions -->
|
||||
|
||||
* Python: `python --version`
|
||||
* MkDocs: `mkdocs --version`
|
||||
* Material: `pip show mkdocs-material | grep -E ^Version`
|
||||
|
||||
### Project configuration
|
||||
|
||||
<!-- Please provide your mkdocs.yml to a REASONABLE amount of detail -->
|
||||
|
||||
``` yaml
|
||||
The contents of your mkdocs.yml
|
||||
```
|
||||
|
||||
### System information
|
||||
|
||||
<!-- Please provide your operating system and browser version -->
|
||||
|
||||
* OS: [The operating system you're running]
|
||||
* Browser: [The browser used, if relevant]
|
||||
38
.github/ISSUE_TEMPLATE/feature.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/feature.md
vendored
Normal file
@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Feature
|
||||
about: Suggest an idea
|
||||
---
|
||||
|
||||
<!--
|
||||
⚠️ WARNING
|
||||
|
||||
Half of all issues created do not contain enough information 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.
|
||||
-->
|
||||
|
||||
__Checklist__:
|
||||
|
||||
<!-- Make sure that your request fulfills all of the following requirements -->
|
||||
|
||||
I checked that...
|
||||
|
||||
- [ ] ... the documentation does not mention anything about my idea
|
||||
- [ ] ... to my best knowledge, my idea wouldn't break something for other users
|
||||
- [ ] ... there are no open or closed issues that are related to my idea
|
||||
|
||||
## Description
|
||||
|
||||
<!-- Please provide a brief description of the feature -->
|
||||
|
||||
### Use Cases
|
||||
|
||||
<!-- Please describe how your suggestion would benefit you and other users -->
|
||||
|
||||
### Screenshots / Mockups
|
||||
|
||||
<!-- If applicable, provide some mockups or screenshots -->
|
||||
12
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
12
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
name: Question
|
||||
about: The issue tracker is not for questions. Please use the Gitter channel.
|
||||
---
|
||||
|
||||
__THE ISSUE TRACKER IS NOT FOR QUESTIONS.__
|
||||
__DO NOT CREATE A NEW ISSUE TO ASK A QUESTION.__
|
||||
|
||||
Please use the [official Gitter channel][1] to ask your question. Any issues
|
||||
that only contain questions
|
||||
|
||||
[1]: https://gitter.im/squidfunk/mkdocs-material
|
||||
Loading…
Reference in New Issue
Block a user