PHP

• PHPStan
• Easy Coding Standard
• Rector

Notes

To save dev time and avoid extraneous commits, code quality checks should be run locally prior to committing and pushing changes to GitHub.

Some projects which had code quality tooling added earlier on have slightly different usage, for example instead of composer run ecs:fix, they might use composer run ecs-fix. Check the composer.json file for the correct name if its not working.

If it's not working in a project locally, please the Head of Engineering know so that they can help resolve it, or allocate the task to someone who can assist. It might be a misconfiguration of the tooling.

If you're struggling with getting checks passing, particularly around phpstan which can sometimes be tricky initially, please create a 1-hour rule (even if its only been a few mins) message and the Head of Engineering so that they can help or point you in the right direction.

Sometimes having phpstan checks pass can get quite complex, especially when targetting higher levels. This can lead to it being a blocker for ongoing development.

To ease development a bit, it is OK to have your working changes merged to staging so that the work can be tested and reviewed, and then posting a 1-hour rule for assistance with getting the code quality checks passing.