5 Simple Steps for code review:

1. Correct:

Does the code do what it’s supposed to?

Does it handle edge cases?

Is it adequately tested to make sure that it stays correct even when other engineers modify it?

Is it performant enough for this use case?

2. Secure:

Does the code have vulnerabilities?

Is the data stored safely?

Is personal identification information (PI) handled correctly?

Could the code be used to induce a DOS?

Is input validation comprehensive enough?

3. Readable:

Is the code easy to read and comprehend?

Does it make clear what the business requirements are (code is written to be read by a human, not by a computer)?

Are tests concise enough?

Are variables, functions and classes named appropriately?

Do the domain models cleanly map the real world to reduce cognitive load?

Does it use consistent coding convention?

4. Elegant:

Does the code leverage well-known patterns?

Does it achieve what it needs to do without sacrificing simplicity and conciseness?

Would you be excited to work in this code?

Would you be proud of this code?

5. Altruist:

Does the code leave the codebase better than what it was?

Does it inspire other engineers to improve their code as well?

Is it cleaning up unused code, improving documentation, introducing better patterns through small-scale refactoring?

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s