Knowledgebase

Reviewing Code Effectively Print

  • softwareengineering, software, security, guide, howto, solution, zillionkinghost, hosting
  • 0

Examining each other's work.

WHAT IT ACHIEVES

Catching defects Spreading knowledge Maintaining consistency Improving design through discussion

WHAT IT IS NOT FOR

Formatting, which tooling handles Demonstrating superiority

WHAT TO REVIEW FOR

Correctness, including edge cases and failures Security Readability Structure Tests Anything duplicating what exists

WHAT TO KEEP SMALL

The change under review.

WHY

Large changes receive superficial review, reliably.

WHAT SIZE WORKS

A few hundred lines at most.

HOW TO PHRASE COMMENTS

About the code, specifically, and with reasoning.

WHAT TO DISTINGUISH

What must change What you suggest What is merely an observation

WHY

Otherwise every comment appears to be a demand.

WHAT TO DO AS THE AUTHOR

Explain the context in the description Respond to every comment Ask when a comment is unclear

WHAT TO AVOID

Reviews that take days Approving without reading Personal remarks


Was this answer helpful?
Back

Are you happy with your experience? Leave us a review on Trustpilot.


Trustpilot