Skip to content

Commit

Permalink
updated contributing.md, added GitHub templates
Browse files Browse the repository at this point in the history
  • Loading branch information
dg committed Jan 4, 2017
1 parent a591038 commit af6561f
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 13 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.gitattributes export-ignore
.gitignore export-ignore
.github export-ignore
.travis.yml export-ignore
tests/ export-ignore
*.sh eol=lf
16 changes: 16 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
- bug report? yes/no
- feature request? yes/no
- version: ?.?.? <!-- exact release version, for bug reports -->

### Description
...

### Steps To Reproduce
... If possible a minimal demo of the problem ...

<!--
REMEMBER, AN ISSUE IS NOT THE PLACE TO ASK QUESTIONS. We will be happy to help you on 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 information. Please try to be as detailed as possible in your report.
Feature requests are welcome. Explain your intentions. It's up to you to make a strong case to convince the project's developers of the merits of this feature.
-->
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
- bug fix? yes/no <!-- #issue numbers, if any -->
- new feature? yes/no
- BC break? yes/no
- doc PR: nette/docs#??? <!-- highly welcome, see https://nette.org/en/writing -->

<!--
Describe your changes here to communicate to the maintainers why we should accept this pull request.
Please add new tests to show the fix or feature works. And take a moment to read the contributing guide https://nette.org/en/contributing
Thanks for contributing to Nette!
-->
32 changes: 19 additions & 13 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -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** &mdash; 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:

0 comments on commit af6561f

Please sign in to comment.