liveBook · Manning

Update comment

As explained in "Looks Good to Me"

An update comment is a code-review comment that records the status, decision, or outcome of an offline discussion related to a proposed change.

An update comment records the status of an offline discussion connected to a proposed change. It summarizes unresolved questions or review concerns, announces direct contact with the author, and signals that another update will likely follow. section 8.5

Use the comment to keep the review understandable while discussion moves elsewhere:

  • Summarize the outstanding questions or areas requiring rework. section 8.5
  • State that you are contacting the author for an offline conversation. section 8.5
  • Update the proposed change after clarifying misunderstandings or discussing revisions. section 8.5

Review concerns require a conversation

“I have several questions about the use cases and see areas that may need rework. I’m contacting the author to discuss these offline and will update this pull request afterward.” section 8.5

How "Looks Good to Me" covers it

How deep it goes
Defines the comment’s purpose and gives a concise sequence: summarize concerns, announce contact, discuss, and update.
Examples
Uses questions piling up, major rework, and previously unaddressed review comments as practical situations.
What it assumes
Assumes a proposed change, a review in progress, and access to the author for direct discussion.
What you can do after
Practice/perform transparent review handoffs while preserving status and follow-up context.
How it connects
Connects code review with pull requests, asynchronous communication, and offline conversation.
Cover of "Looks Good to Me"
liveBookmanning.com
Read "Looks Good to Me" on liveBook Get the book at manning.com

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.