Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (31 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 1.62 KB

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.

Unit-Tests

Add a test for your pull-request.

You can run the unit-tests by calling phpunit from the root of the project.

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. Please try and report any bugs with a minimal reproducible example, it will make things easier for other contributors and your problems will hopefully be resolved quickly.