src
1 year ago
stubs
4 years ago
.styleci.yml
4 years ago
CHANGELOG.md
4 years ago
CODE_OF_CONDUCT.md
4 years ago
CONTRIBUTING.md
4 years ago
ISSUE_TEMPLATE.md
4 years ago
LICENSE.md
4 years ago
PULL_REQUEST_TEMPLATE.md
4 years ago
README.md
4 years ago
composer.json
1 year ago
phpunit.xml
4 years ago
upgrade.sh
4 years ago
CONTRIBUTING.md
33 lines
| 1 | # Contributing |
| 2 | |
| 3 | Contributions are **welcome** and will be fully **credited**. |
| 4 | |
| 5 | We accept contributions via Pull Requests on [](https://github.com/pragmarx/coollectionGithub](https://github.com/pragmarx/coollection](https://github.com/pragmarx/coollection). |
| 6 | |
| 7 | |
| 8 | ## Pull Requests |
| 9 | |
| 10 | - **[](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.mdPSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md](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 [](http://semver.org/SemVer v2.0.0](http://semver.org/](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 [](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messagessquash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages](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**! |
| 33 |