Contributing

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Please follow the PSR-2 Coding Standard and PHP-FIG Naming Conventions.
Remember to follow SemVer. If you are changing the behavior, or the public api, you may need to update the docs.
Make sure that the current tests pass, and if you have added something new, add the tests where relevant.
Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
You may also need to rebase to avoid merge conflicts.

StyleCI is set up to automatically check and fix any code style issues.

Pull Request Process

Create a personal fork of the project on Github.
Clone the fork on your local machine. Your remote repo on Github is called origin.
Add the original repository as a remote called upstream.
If you created your fork a while ago be sure to pull upstream changes into your local repository.
Create a new branch to work on! Branch from develop.
Implement/fix your feature, comment your code.
Follow the code style ps2 and ps4 for your code
Write or adapt tests as needed.
Squash your commits into a single commit with git's interactive rebase
Push your branch to your fork on Github, the remote origin.
From your fork open a pull request in the correct branch. Target the project's develop branch.
Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch.