Document php-cs-fixer in the developer documentation #1963
Conversation
This fixes #295, by adding a small, concise section on php-cs-fixer to the developer docs. Specifically, it shows how to review and fix coding standard violations using `make test-php-style` and `make test-php-style-fix` respectively.
settermjd
added
review required
waiting on feedback
developer docs
p3-medium
There was a problem hiding this comment.
LGTM
Note that we also run squizlabs/php_codesniffer on the acceptance test code. If a developer does not touch acceptance test PHP code, then it won't fail this check :) After this PR is merged, I can make some small addition to the text to also mention squizlabs/php_codesniffer - because it is not always able to auto-fix the code.
Thanks for the extra information and the rapid approval, @phil-davis. As soon as the build's run again (after merging the latest from master) I'll merge and backport it. |
delete-merged-branch
bot
deleted the
document-make-target-for-testing-and-correcting-php-style
branch
Adding a table of contents - has been forgotten. Referencing: #1963
This addresses #295, by adding a small, concise section on php-cs-fixer to
the developer docs. Specifically, it shows how to review and fix coding
standard violations using
make test-php-styleandmake test-php-style-fixrespectively.