You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
29 lines
1.1 KiB
29 lines
1.1 KiB
8 years ago
|
# Contributing
|
||
|
|
|
||
|
|
Feel free to contribute!
|
||
|
|
|
||
|
|
Submit a pull on [Github](https://github.com/element/:package_name).
|
||
|
|
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
|
||
|
|
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
|
||
|
|
|
||
|
|
- **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/).
|
||
|
|
|
||
|
|
- **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
|
||
|
|
```
|
||
|
|
|