Skip to content

How-to Guides

Technical References

Launch A Site With VIP /

Code review

Code review is a key component of ensuring your site is secure and performant. We encourage you to run the PHP_CodeSniffer tool in your development environment or code editor, allowing you to fix errors as you code and develop to VIP best practices.

When you open a Pull Request (PR) for your codebase in GitHub, we offer both automated scans and manual reviews to clients:

Automated scans

When you open a PR in the GitHub, your entire codebase will be automatically scanned against VIP Coding Standards by the VIP Code Analysis bot. If you have questions about how to address specific errors or warnings, you can open a Zendesk ticket with our team. 

Manual code review

Clients with Application Support may request specific developer feedback on their code (including themes and custom plugins) by adding the “[VIP] Review Request” label to their PR. Before adding the label, ensure that you’ve addressed as many errors and warnings from the automated scan as possible. If the changeset is larger than 1000 lines of code, it will need to be scheduled for a review. Where possible, we recommend keeping PRs small by breaking them down into atomic commits. Please allow for 10-15 business days in your project timeline to complete the first and subsequent review cycles.

Note

VIP’s code review focuses on the performance and security considerations in PHP, custom JavaScript, and SVG files. Please note that we do not review HTML, CSS, SASS, many popular third-party JavaScript libraries, or built JavaScript files.

Further reading

VIP code review

Interpreting your PHPCS report

VIP’s GitHub PR workflow

Last updated: December 15, 2020