liveBook · Manning

Request

As explained in "Looks Good to Me"

The part of a code-review comment that states the change the author is asked to make.

A request is the code-review comment sentence that tells the author what change to make. Use concise transformation verbs such as rename, remove, consolidate, expand, fix, rewrite, move, or reorganize. State the desired end condition so the author can recognize completion. section 6.1.3

Compose a change request with the Triple-R pattern:

  • Request: state what the author should do. section 6.1.3
  • Rationale: explain why the change is warranted, adding references or links when useful. section 6.1.3
  • Result: describe a measurable end state, such as a metric, screenshot, or target code shape. 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.

Shows a request that names the version change, explains the deprecation risk, and connects the fix to consistency across endpoints. section 6.1.3

How "Looks Good to Me" covers it

How deep it goes
Explains transformation verbs, completion criteria, rationale, and the three-part Triple-R procedure.
Examples
Uses an endpoint update from API version 2 to version 3 as a concrete request example.
What it assumes
Assumes familiarity with code review and change requests while teaching how to make requested outcomes explicit.
What you can do after
Practice/perform concise review requests with explicit actions, reasons, and verifiable completion states.
How it connects
Connects requests with rationale, measurable results, and effective code-review comments.
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.