matrix-php-sdk/CONTRIBUTING.md

# Contributing

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/:vendor/:package_name).


## 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``.

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **Create feature branches** - Don't ask us to pull from your master branch.

- **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.


## Running Tests

``` bash
$ composer test
```


**Happy coding**!
Initial Commit 2013-08-07 17:33:05 +00:00			`# Contributing`

			`Contributions are welcome and will be fully credited.`

use `:vendor` placeholder to make the package more useful for general use, replace references to `thephpleague` and `league` with `:vendor`. 2015-11-27 22:08:09 +00:00			`We accept contributions via Pull Requests on [Github](https://github.com/:vendor/:package_name).`
Initial Commit 2013-08-07 17:33:05 +00:00

			`## Pull Requests`

Replace check-codestyle & fix-codestyle with check-style & fix-style respecively 2016-09-14 15:22:46 +00:00			- [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``.
Initial Commit 2013-08-07 17:33:05 +00:00
			`- Add tests! - Your patch won't be accepted if it doesn't have tests.`

Update CONTRIBUTING.md 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.
Initial Commit 2013-08-07 17:33:05 +00:00
Update CONTRIBUTING.md 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.`
Initial Commit 2013-08-07 17:33:05 +00:00
Update CONTRIBUTING.md 2014-05-20 08:42:38 +00:00			`- Create feature branches - Don't ask us to pull from your master branch.`
Initial Commit 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.`

Update CONTRIBUTING.md Not everyone may be familiar with the term (or the details of) "squashing." A link to the git documentation would be helpful in this case. 2015-04-28 19:49:03 +00:00			`- 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.`
Initial Commit 2013-08-07 17:33:05 +00:00

			`## Running Tests`

			``` bash
use composer test 2015-06-26 23:38:04 +00:00			`$ composer test`
Initial Commit 2013-08-07 17:33:05 +00:00			```


			`Happy coding!`