From bd70b5ce48eb4f39da1762278b5a632e89483efa Mon Sep 17 00:00:00 2001 From: David Grudl Date: Thu, 22 Dec 2016 04:57:37 +0100 Subject: [PATCH] updated contributing.md, added GitHub templates --- .gitattributes | 1 + .github/issue_template.md | 16 ++++++++++++++++ .github/pull_request_template.md | 12 ++++++++++++ contributing.md | 32 +++++++++++++++++++------------- 4 files changed, 48 insertions(+), 13 deletions(-) create mode 100644 .github/issue_template.md create mode 100644 .github/pull_request_template.md diff --git a/.gitattributes b/.gitattributes index 20c7d6b38..0bb91f72d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,6 @@ .gitattributes export-ignore .gitignore export-ignore +.github export-ignore .travis.yml export-ignore tests export-ignore *.sh eol=lf diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 000000000..a6a22a9b5 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,16 @@ +- bug report? yes/no +- feature request? yes/no +- version: ?.?.? + +### Description +... + +### Steps To Reproduce +... If possible a minimal demo of the problem ... + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..8bcf026ee --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +- bug fix? yes/no +- new feature? yes/no +- BC break? yes/no +- doc PR: nette/docs#??? + + diff --git a/contributing.md b/contributing.md index 860882bf7..184152c02 100644 --- a/contributing.md +++ b/contributing.md @@ -1,27 +1,33 @@ How to contribute & use the issue tracker ========================================= -The issue tracker is the preferred channel for bug reports, features requests -and submitting pull requests, but please respect the following restrictions: +Nette welcomes your contributions. There are several ways to help out: -* Please **do not** use the issue tracker for personal support requests (use - [Nette forum](https://forum.nette.org) or [Stack Overflow](http://stackoverflow.com)). +* Create an issue on GitHub, if you have found a bug +* Write test cases for open bug issues +* Write fixes for open bug/feature issues, preferably with test cases included +* Contribute to the [documentation](https://nette.org/en/writing) -* Please **do not** derail or troll issues. Keep the discussion on topic and - respect the opinions of others. +Issues +------ -* Use the GitHub **issue search** — check if the issue has already been - reported. +Please **do not use the issue tracker to ask questions**. We will be happy to help you +on [Nette forum](https://forum.nette.org) or chat with us on [Gitter](https://gitter.im/nette/nette). -A good **bug report** shouldn't leave others needing to chase you up for more +A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. **Feature requests** are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. -Nette welcomes **pull requests**. If you'd like to contribute, please take a moment -to [read the guidelines](https://nette.org/en/contributing) in order to make -the contribution process easy and effective for everyone involved. +Contributing +------------ -Thanks! +If you'd like to contribute, please take a moment to read [the contributing guide](https://nette.org/en/contributing). + +The best way to propose a feature is to discuss your ideas on [Nette forum](https://forum.nette.org) before implementing them. + +Please do not fix whitespace, format code, or make a purely cosmetic patch. + +Thanks! :heart: