This is a very small library with a very limited scope but if you want to contribute please feel free to do so.
You can open a new issue once you have checked one covering your issue hasn't been opened yet.
If you want to fix a bug or add a missing feature you can open a new pull-request.
Please note that you need a PHP 7.3 or later for using this library (running the tests requires at least php 8.2).
Basic steps:
- Fork this repository
- Clone it locally
- Install dependencies with Composer
$ composer install
- Create a branch on your fork
- Commit & push
- Open a pull-request from your branch
- Profit
Some guidelines:
- Before committing make sure to format the code accordingly:
$ make php-cs-fixer-fix
- Also make sure the tests pass successfully and you have sufficient coverage
$ make test-unit
- use conventional commits to make the commit messages more readable and to allow for automatic semantic versioning and changelog generation
- Use the present tense ("add feature" not "added feature")
- Use the imperative mood ("move cursor to..." not "moves cursor to...")
- Limit the first line to 72 characters, or less