.github/CONTRIBUTING.md

   1 # Contributing
   2
   3 Contributions are **welcome** and will be fully **credited**.
   4
   5 We accept contributions via Pull Requests on [Github](https://github.com/dannyvankooten/PHP-Router).
   6
   7
   8 ## Pull Requests
   9
  10 - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
  11
  12 - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
  13
  14 - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
  15
  16 - **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
  17
  18 - **Create feature branches** - Don't ask us to pull from your master branch.
  19
  20 - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
  21
  22 - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
  23
  24
  25 ## Running Tests
  26
  27 ``` bash
  28 $ composer test
  29 ```
  30
  31
  32 **Happy coding**!