Back to the full dot-point answer
NSWSoftware EngineeringQuick questions
Module 4: Software Engineering Project
Quick questions on Code review and quality explained: HSC Software Engineering Module 4
11short Q&A pairs drawn directly from our worked dot-point answer. For full context and worked exam questions, read the parent dot-point page.
What is code review?Show answer
A peer reviews every change before it is merged. In modern Git workflows, this happens on pull requests:
What is style guides?Show answer
A document (or shared linter config) describing how the team writes code:
What is linters and formatters?Show answer
Automated tools that enforce style and catch common mistakes:
What is static analysis?Show answer
Goes deeper than linting. Analyses the code structure without running it.
What is pre-commit hooks?Show answer
Run linters and formatters automatically on every commit, before the change leaves the developer's machine. Saves a round trip with CI.
What is architecture decision records (ADRs)?Show answer
For decisions that shape the codebase, write a short record:
What is metrics?Show answer
Use metrics as signals to investigate, not targets to optimise (Goodhart's law).
What is treating code review as gatekeeping?Show answer
Review is collaborative. The goal is the best version of the change, not the reviewer's preferred version.
What is nitpicking style in review?Show answer
Configure a formatter and let it handle style. Review humans for design and correctness only.
What is approving without reading?Show answer
"LGTM" without comments on a 500-line PR helps no one. If you do not have time to review, say so.
What is no review for "small changes"?Show answer
Production outages routinely come from one-line changes. Every change goes through review. :::