Documentation > Contributing
Everyone is welcome to help out! But to keep this project sustainable, please ensure your contribution respects the requirements below.
PR Requirements
Requirements on pull requests;
- All tests MUST pass.
- Code coverage MUST remain at 100%.
- Code MUST adhere to PSR-1 and PSR-12 code standards.
Base your patch on corresponding version branch, and target that version branch in your pull request.
Version | Branch | PHP | Status |
---|---|---|---|
2.0 |
v2.0-main |
^8.0 |
Current version |
1.7 |
v1.7-master |
^7.4|^8.0 |
Bug fixes only |
1.6 |
v1.6-master |
^7.4|^8.0 |
- |
1.5 |
v1.5-master |
^7.4|^8.0 |
- |
1.4 |
- | ^7.1 |
- |
1.3 |
- | ^5.4|^7.0 |
- |
1.2 |
- | - | - |
1.1 |
- | - | - |
1.0 |
- | - | - |
Dependency management
Install or update dependencies using Composer.
# Install dependencies
make install
# Update dependencies
make update
Code standard
This project uses PSR-1 and PSR-12 code standards.
# Check code standard adherence
make cs-check
Unit testing
Unit tests with PHPUnit, coverage with Coveralls
# Run unit tests
make test
# Create coverage
make coverage
Contributors
- Sören Jensen (maintainer)
- Fredrik Liljegren
- Armen Baghumian Sankbarani
- Ruslan Bekenev
- Joshua Thijssen
- Simon Lipp
- Quentin Bellus
- Patrick McCarren
- swmcdonnell,
- Ignas Bernotas
- Mark Herhold
- Andreas Palm
- pmaasz
- Alexey Stavrov
- Michael Slezak
- Pierre Seznec
- rmeisler
- Nickolay V
- Shmyrev
- Christoph Kempen,
- Marc Roberts
- Antonio Mora
- Simon Podlipsky
- etrinh