Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 1.68 KB
Raw

Contributing

Thank you for contributing!

Here are some guidelines that you need to follow. These guidelines exist to keep the code base clean.

Workflow

  1. Fork the project
  2. Create a local development branch for the changes.
  3. Commit a change and push your local branch to your github fork.
  4. Send a pull-request for your changes to master.

Coding Standard

Use PSR-2:

License

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.

Tests

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.

Travis

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.

Code Review

Your pull-request will be under code review. So be sure that your code is (nearly) SOLID and not STUPID.

Reporting Bugs

Issues can be reported on the issue tracker.