Repository navigation
Contributing
Contributions to this project are greatly appreciated. Before contributing, please read the following to make the process as easy as possible.
This project uses git-flow as a branching model. The master branch is the release branch, this branch is running on the live platform. The development branch is used to collect commits for the next release.
The following config is used:
- Branch name for production releases: master
- Branch name for "next release" development: development
- Feature branch prefix: feature/
- Bugfix branch prefix: bugfix/
- Release branch prefix: release/
- Hotfix branch prefix: hotfix/
- Support branch prefix: support/
- Version tag prefix: none
A good cheat-sheet is https://danielkummer.github.io/git-flow-cheatsheet/
Issues should be created for basically anything that is happening in the code. This helps in keeping track why something changes. When creating a new issue two templates exist, one for bugs and one for features. If the issue concerns one of these two topics, use the template. If the issue is about something else, create a regular issue. Use the appropriate labels on the issue to help maintainers prioritize.
If you are also the person who will write code for the issue, assign the issue to yourself.
Fork the project and clone it. Use git-flow to create a feature/* branch, if you're working on a feature. Working on an existing issue? Assign it to yourself so others know the issue is being fixed! Write your code, and preferably add unit tests. When done, create a pull request from your feature branch.
Don't forget to rebase your code whenever changes in development happen!
Please use PHP-CS-Fixer before you commit. Using PHP CS Fixer can be made easy by, for example, using PHPStorm and using the PHP CS Fixer inspection to notify you of style errors.
Use the .php_cs config.
If you have written code and want it merged you will need to create a pull request. Pull requests should be done against the development branch, any other branch will get your pull request closed. Attach @rogierknoester as the reviewer for your pull request. Please make sure your code can be merged.