matrix-php-sdk/CONTRIBUTING.md

33 lines
1.3 KiB
Markdown
Raw Normal View History

2013-08-07 17:33:05 +00:00
# Contributing
Contributions are **welcome** and will be fully **credited**.
We accept contributions via Pull Requests on [Github](https://github.com/:vendor/:package_name).
2013-08-07 17:33:05 +00:00
## Pull Requests
- **[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``.
2013-08-07 17:33:05 +00:00
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
2014-05-20 08:42:38 +00:00
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
2013-08-07 17:33:05 +00:00
2014-05-20 08:42:38 +00:00
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
2013-08-07 17:33:05 +00:00
2014-05-20 08:42:38 +00:00
- **Create feature branches** - Don't ask us to pull from your master branch.
2013-08-07 17:33:05 +00:00
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
- **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.
2013-08-07 17:33:05 +00:00
## Running Tests
``` bash
2015-06-26 23:38:04 +00:00
$ composer test
2013-08-07 17:33:05 +00:00
```
**Happy coding**!