From d7ce2e90400734c2d4e6f4a300b977201aaaf659 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 18 Oct 2020 11:38:45 +0200 Subject: [PATCH] Updated contribution guidelines --- .github/ISSUE_TEMPLATE/bug.md | 17 +++++++++++------ .github/ISSUE_TEMPLATE/config.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature.md | 13 +++++++++---- .github/ISSUE_TEMPLATE/translate.md | 2 +- CONTRIBUTING.md | 6 +++--- 5 files changed, 26 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index c46b04f27..7f9c80d48 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -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 - + ### Actual behavior @@ -57,7 +60,7 @@ __I checked that...__ ### Project configuration - + ``` 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c9107c1ec..e9e78ca0d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index 6637bd589..2fa663994 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -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 + + [1]: https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/translate.md b/.github/ISSUE_TEMPLATE/translate.md index be3f7d784..c8626ab9c 100644 --- a/.github/ISSUE_TEMPLATE/translate.md +++ b/.github/ISSUE_TEMPLATE/translate.md @@ -44,4 +44,4 @@ assignees: '' }[key] }}{% endmacro %} ``` -Thanks! + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca43ddeb1..5710f4aec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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