Skip to content

Commit

Permalink
[*]: add "CONTRIBUTING.md"
Browse files Browse the repository at this point in the history
  • Loading branch information
voku committed Sep 16, 2016
1 parent 93d89c9 commit 5637d1d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
/circle.yml export-ignore
/phpdox.xml export-ignore
/phpunit.xml export-ignore
/CONTRIBUTING.md export-ignore
/ISSUE_TEMPLATE.md export-ignore
/PULL_REQUEST_TEMPLATE.md export-ignore
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# How to Contribute

## Pull Requests

1. Create your own [fork](https://help.github.com/articles/fork-a-repo) of this repo
2. Create a new branch for each feature or improvement
3. Send a pull request from each feature branch to the **master** branch

It is very important to separate new features or improvements into separate
feature branches, and to send a pull request for each branch. This allows me to
review and pull in new features or improvements individually.

## Style Guide

All pull requests must adhere to the [PSR-2 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).

## Unit Testing

All pull requests must be accompanied by passing PHPUnit unit tests and
complete code coverage.

[Learn about PHPUnit](https://github.com/sebastianbergmann/phpunit/)

0 comments on commit 5637d1d

Please sign in to comment.