mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-12 01:50:52 +01:00
Updated contribution guidelines
This commit is contained in:
parent
0067197a36
commit
d7ce2e9040
17
.github/ISSUE_TEMPLATE/bug.md
vendored
17
.github/ISSUE_TEMPLATE/bug.md
vendored
@ -2,7 +2,7 @@
|
||||
name: Bug
|
||||
about: Report a bug
|
||||
title: ''
|
||||
labels: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
@ -17,14 +17,17 @@ assignees: ''
|
||||
Why? Because the maintainers of this project are wasting a lot of time
|
||||
answering questions that are not directly related to this project.
|
||||
|
||||
Make sure that your request fulfills all of the following requirements.
|
||||
Make sure that your request fulfills ALL of the following requirements. If one
|
||||
requirement cannot be satisfied, please explain in detail why.
|
||||
-->
|
||||
|
||||
__I checked that...__
|
||||
- [ ] I've read the [contribution guidelines][1] and agree with them
|
||||
|
||||
__I've found a bug and 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)
|
||||
- [ ] ... the documentation does not mention anything about my problem
|
||||
- [ ] ... there are no open or closed issues that are related to my problem
|
||||
|
||||
## Description
|
||||
@ -33,7 +36,7 @@ __I checked that...__
|
||||
|
||||
### Expected behavior
|
||||
|
||||
<!-- Please describe what you expected to happen -->
|
||||
<!-- Please describe what you expect to happen -->
|
||||
|
||||
### Actual behavior
|
||||
|
||||
@ -57,7 +60,7 @@ __I checked that...__
|
||||
|
||||
### Project configuration
|
||||
|
||||
<!-- Please provide your mkdocs.yml to a REASONABLE amount of detail -->
|
||||
<!-- Please provide your mkdocs.yml to a reasonable amount of detail -->
|
||||
|
||||
``` yaml
|
||||
The contents of your mkdocs.yml
|
||||
@ -69,3 +72,5 @@ The contents of your mkdocs.yml
|
||||
|
||||
* OS: ...
|
||||
* Browser: ...
|
||||
|
||||
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md
|
||||
|
4
.github/ISSUE_TEMPLATE/config.yml
vendored
4
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,5 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Question
|
||||
url: https://stackoverflow.com
|
||||
about: If you have a question ask it there! All questions on GitHub will be deleted!
|
||||
url: https://gitter.im/squidfunk/mkdocs-material
|
||||
about: Do not create issues for questions, ask them on Gitter
|
||||
|
13
.github/ISSUE_TEMPLATE/feature.md
vendored
13
.github/ISSUE_TEMPLATE/feature.md
vendored
@ -2,7 +2,7 @@
|
||||
name: Feature
|
||||
about: Suggest an idea
|
||||
title: ''
|
||||
labels: ''
|
||||
labels: feature
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
@ -17,13 +17,16 @@ assignees: ''
|
||||
Why? Because the maintainers of this project are wasting a lot of time
|
||||
answering questions that are not directly related to this project.
|
||||
|
||||
Make sure that your request fulfills all of the following requirements
|
||||
Make sure that your request fulfills ALL of the following requirements. If one
|
||||
requirement cannot be satisfied, please explain in detail why.
|
||||
-->
|
||||
|
||||
__I checked that...__
|
||||
- [ ] I've read the [contribution guidelines][1] and agree with them
|
||||
|
||||
__I want to suggest an idea and checked that ...__
|
||||
|
||||
- [ ] ... the documentation does not mention anything about my idea
|
||||
- [ ] ... to my best knowledge, my idea wouldn't break something for other users
|
||||
- [ ] ... the documentation does not mention anything about my idea
|
||||
- [ ] ... there are no open or closed issues that are related to my idea
|
||||
|
||||
## Description
|
||||
@ -37,3 +40,5 @@ __I checked that...__
|
||||
### Screenshots / Mockups
|
||||
|
||||
<!-- If applicable, provide some mockups or screenshots -->
|
||||
|
||||
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md
|
||||
|
2
.github/ISSUE_TEMPLATE/translate.md
vendored
2
.github/ISSUE_TEMPLATE/translate.md
vendored
@ -44,4 +44,4 @@ assignees: ''
|
||||
}[key] }}{% endmacro %}
|
||||
```
|
||||
|
||||
Thanks!
|
||||
<!-- Thanks you! You've made Material for MkDocs even better! -->
|
||||
|
@ -1,7 +1,7 @@
|
||||
# Contributing
|
||||
|
||||
Interested in contributing to the Material for MkDocs? Want to report a bug?
|
||||
Before you do, please read the following guidelines.
|
||||
Have a question? Before you do, please read the following guidelines.
|
||||
|
||||
## Submission context
|
||||
|
||||
@ -27,8 +27,8 @@ a Pull Request with a fix. However, before doing so, please read the
|
||||
You can request a new feature by submitting an issue to our GitHub Repository.
|
||||
If you would like to implement a new feature, please submit an issue with a
|
||||
proposal for your work first, to be sure that it is of use for everyone, as
|
||||
the Material for MkDocs is highly opinionated. Please consider what kind of
|
||||
change it is:
|
||||
Material for MkDocs is highly opinionated. Please consider what kind of change
|
||||
it is:
|
||||
|
||||
* For a **major feature**, first open an issue and outline your proposal so
|
||||
that it can be discussed. This will also allow us to better coordinate our
|
||||
|
Loading…
Reference in New Issue
Block a user