liveBook · Manning

Rationale

As explained in "Looks Good to Me"

The part of a code-review comment that explains why the requested change is warranted.

Rationale explains why a requested code change is warranted. It gives the author context, justification, and evidence instead of merely describing what the code does. section 6.1.3

Compose a change request with the Triple-R pattern:

  • Request: state the transformation with a concise, actionable verb. section 6.1.3
  • Rationale: explain why the request is warranted, adding references or links when useful. section 6.1.3
  • Result: define a measurable end state, such as a metric, screenshot, or expected code shape. section 6.1.3

Moving a method

Request: move AuthenticateUser() into AuthenticationUtilities. Rationale: related methods already belong there, the method is called repeatedly, and the team agreement recommends that placement. section 6.1.3

needs change: Can we update this endpoint to use version 3 (v3)? The call 
to our getCoordinates() method currently references version 2 (v2), a soon-
to-be-deprecated (link) version, which will cause functionality to break. 
Also, our other endpoints are already using v3; updating this will keep our
code consistent.

Compare consistency and deprecation evidence in a concise endpoint-change rationale. section 6.1.3

How "Looks Good to Me" covers it

How deep it goes
Defines rationale, supporting references, and its place in the Request-Rationale-Result pattern.
Examples
Uses method relocation and endpoint versioning to demonstrate evidence-based review rationales.
What it assumes
Builds on code-review requests and the practice of explaining why code was implemented in a particular way.
What you can do after
Apply it via the Triple-R pattern to make review requests clearer and reduce misinterpretation.
How it connects
Connects code review comments with actionable requests, measurable results, meaningful code comments, and the 5P process.
Cover of "Looks Good to Me"
liveBookmanning.com
Read "Looks Good to Me" on liveBook Get the book at manning.com

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.