From 7b899ddda57a938c2372b6545c15e1e866f4fa3c Mon Sep 17 00:00:00 2001 From: David Grudl Date: Thu, 22 Dec 2016 05:06:20 +0100 Subject: [PATCH] updated contributing.md, added GitHub templates --- .gitattributes | 1 + .github/issue_template.md | 16 ++++++++++++++++ .github/pull_request_template.md | 11 +++++++++++ contributing.md | 30 +++++++++++++++++------------- 4 files changed, 45 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 8af211b1..0842f1f2 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,4 +1,5 @@ .gitattributes export-ignore .gitignore export-ignore +.github export-ignore .travis.yml export-ignore tests/ export-ignore diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 00000000..1d02d14b --- /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 00000000..b41cb73a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +- bug fix? yes/no +- new feature? yes/no +- BC break? yes/no + + diff --git a/contributing.md b/contributing.md index b48d3c38..a6a9e4de 100644 --- a/contributing.md +++ b/contributing.md @@ -1,27 +1,31 @@ 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: +Dibi welcomes your contributions. There are several ways to help out: -* Please **do not** use the issue tracker for personal support requests (use - [dibi forum](https://forum.dibiphp.com) 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 -* 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 [Dibi forum](https://forum.dibiphp.com). -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. -We welcome **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! +The best way to propose a feature is to discuss your ideas on [Dibi forum](https://forum.dibiphp.com) before implementing them. + +Please do not fix whitespace, format code, or make a purely cosmetic patch. + +Thanks! :heart: