Hey, thank you for contributing. Here are some tips to make it easy for you.
- Fork the project
git clone
it andcomposer install
the dependencies- Create a new branch
- Think about how the changes you are about to make can be tested, write tests before coding
- Run tests, make sure they fail
- Write the actual code to make the tests pass
- Open a pull request detailing your changes. Make sure to follow the template
We use PHPUnit for automated tests.
Have a new feature? You can start off by writing some tests that detail the behaviour you want to achieve and go from there.
Fixing a bug? The best way to ensure it is fixed for good and never comes back is to write a failing test for it and then make it pass. If you can not figure out how to fix it yourself, feel free to submit a PR with a failing test.
Run the testsuite
composer test
Formatting is automated through php_codesniffer.
Check the codestyle
composer check-style
Apply automated fixes
composer fix-style