Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 2.02 KB

How to contribute

Community contributions are one of the key points that make open source software so great. And concrete5 is no exception, so we'd like to thank you for your help.

Before submitting pull requests, please be sure to read these pages:

  • Adopting a common coding style makes developers life easier and may be helpful in finding some kind of bugs. Furthermore, like @aembler once said, we have to be good citizens: speaking the same dialect is useful for everybody. So, please be sure to consult the Coding-Style Guidelines.

    One easy, secure and fast way to fix coding style problems is using php-cs-fixer. To fix a file simply call

    php-cs-fixer --config-file==<webroot>/.php_cs fix <filename>

    Please run the above command on every PHP-only file included in your pull requests (preferably in a separated commit).

  • If you used to develop for concrete5 Legacy (v5.6 and older), you should read the Migration Guide: it explains some of the main differences introduced in concrete5 5.7 and later.

  • This is not a repository for unconfirmed bugs. If this is an unconfirmed bug (and almost all of them are), they should be posted to the official concrete5 bug tracker so that they can be confirmed and voted on. Just because something is posted here does not guarantee it will be placed into a release milestone. Exceptions to this rule include issues that are accompanied by a pull request, but even a pull request isn't guaranteed to be accepted into the core.

  • Pull requests that address existing issues are much much more likely to be accepted than unsolicited pull requests. Pull requests that address issues with the contributor:community label and adhere to the coding style guidelines are almost guaranteed to be accepted in some form or another.

Thanks everyone!