Thank you for contributing!
Here are some guidelines that you need to follow. These guidelines exist to keep the code base clean.
- Fork the project
- Create a local development branch for the changes.
- Commit a change and push your local branch to your github fork.
- Send a pull-request for your changes to
master.
Use PSR-2:
- https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
This project is under MIT License. Every file that contains PHP code must have a docblock at the top of the file that contains the license at a minimum.
Check this for more informations about MIT License.
Add a functional and/or an unit test for your pull-request.
You can run tests on provisioned docker images which requires Docker.
Create the image with make image and run tests with make test.
In alternative you can run the test with ./vendor/bin/codecept run on your host.
Your pull-request will run through Travis CI
If you break the tests, your code wont be merged, so make sure that your code is working before opening up a pull-request.
Your pull-request will be under code review. So be sure that your code is (nearly) SOLID and not STUPID.
Issues can be reported on the issue tracker.