Skip to content

Commit

Permalink
Create CONTRIBUTING.md (fenom-template#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
sreenadh authored Apr 23, 2018
1 parent c1531ea commit 85bdf5c
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Contributing
============

Issue tracker
-------------

The Issue tracker serves mainly as a place to report bugs and request new features.
Please do not abuse it as a general questions or troubleshooting location.

For these questions you can always use the
[fenom tag](https://stackoverflow.com/questions/tagged/fenom) at [Stack Overflow](https://stackoverflow.com/).

* Please provide a small example in php/html that reproduces your situation
* Please report one feature or one bug per issue
* Failing to provide necessary information or not using the issue template may cause the issue to be closed without consideration.

Pull requests
-------------

Pull requests should be always based on the default [development](https://github.com/fenom-template/fenom/tree/master)
branch except for backports to older versions.

Some guidelines:

* Use an aptly named feature branch for the Pull request.

* Only files and lines affecting the scope of the Pull request must be affected.

* Make small, *atomic* commits that keep the smallest possible related code changes together.

* Code should be accompanied by a unit test testing expected behaviour.

When updating a PR, do not create a new one, just `git push --force` to your former feature branch, the PR will
update itself.

0 comments on commit 85bdf5c

Please sign in to comment.