CONTRIBUTING.md 1.2KB

1234567891011121314151617181920212223242526272829303132
  1. # Contributing
  2. Contributions are **welcome** and will be fully **credited**.
  3. We accept contributions via Pull Requests on [Github](https://github.com/2amigos/yii2-leaflet-extension).
  4. ## Pull Requests
  5. - **[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).
  6. - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
  7. - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
  8. - **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
  9. - **Create feature branches** - Don't ask us to pull from your master branch.
  10. - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
  11. - **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 before submitting.
  12. ## Running Tests
  13. ``` bash
  14. $ phpunit
  15. ```
  16. **Happy coding**!