Please note that not all contributions will be accepted. It is our promise to provide the best possible experience and quality and because of that, deeper knowledge of codebase may be needed.
Changes in Orisai code larger than few lines should be preceded by an issue, so we may discuss correct solution. We may implement the solution and, if we agree on it, supporting that effort will greatly lower the wait time.
Do you have a problem, want a new feature or something else? Just open issue in related repository.
Any pull request must pass our CI checks. For most packages it means passing PHPStan, PHP_CodeSniffer and coverage tests. Ideally, all lines of code should be covered and create no mutants.
For all the tasks mentioned above we have a Makefile in each package:
Namely, these Makefile tasks must pass:
make phpstan- PHPStan checksmake cs- Our coding standardmake tests- Tests written with PHPUnit
Ideally, full coverage should be achieved (but is not strictly required):
make coverage-html- generates HTML code coverage into var/coverage/html/index.htmlmake mutations- generates mutation tests coverage into var/coverage/mutations/infection.html (and ** infection.log**)