liveBook · Manning

Context/justification

As explained in "Looks Good to Me"

An explanation of the reasons, circumstances, decisions, and alternatives behind a code change.

Context/justification explains why a code change was made. It gives reviewers the decisions, circumstances, conversations, alternatives, and steps behind the implementation, reducing confusion during review. section 2.3.2

A useful justification can answer:

A reviewable explanation

Use a few organized sentences or paragraphs to describe the situation, the chosen approach, rejected alternatives, relevant discussions, and the path taken to reach the change. Add a self-contained use case, such as a customer issue, open-ticket behavior, or happy path, when a scenario makes the rationale clearer. section 2.3.2

How "Looks Good to Me" covers it

How deep it goes
Explains the rationale components and suggests organized detail, but stops short of prescribing a fixed template.
Examples
Uses customer issues, open-ticket behavior, missing functionality, and happy paths as scenarios for explaining changes.
What you can do after
Apply it by writing clearer pull-request descriptions that help reviewers understand implementation decisions and change history.
How it connects
Connects code review with pull requests, use cases, alternatives, testing, and categorization prefixes.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of "Looks Good to Me". The section links point to the parts of the book it draws on.