liveBook · Manning

Comment signal

As explained in "Looks Good to Me"

A comment signal is a marker or convention that communicates the required status or priority of a code-review comment.

A comment signal is a marker or convention that tells a pull-request author whether feedback requires a change. It removes guesswork, helps authors focus on blocking comments, and lets them confidently close informational ones. Teams can choose a lightweight signal vocabulary or adopt a more formal system. section 6.1.2 section 6.4

Make the requested action unmistakable

needs change: This is importing the wrong module 'ts/widgets'. It should be importing 'ts/components'.

MoSCoW comments provide another option: prefix feedback with M:, S:, C:, or W: for Must, Should, Could, or Would. Must blocks approval; Should requires a reason to ignore and reviewer agreement; Could is optional; Would expresses personal preference or educational guidance. Teams should experiment with the system, because boundaries between categories may prove too blurry.

A signal works best when it accompanies a clear, objective request and its rationale. Pairing the marker with context makes the intended outcome easier to understand and less likely to sound like personal preference. section 6.2 section 6.4

How "Looks Good to Me" covers it

How deep it goes
Compares team signals, MoSCoW categories, and Conventional Comments, stopping short of prescribing one universal classification.
Examples
Uses import corrections, MoSCoW-prefixed comments, and Conventional Comment labels and decorations as concrete formats.
What it assumes
Assumes familiarity with code reviews while teaching how to make review feedback’s required status explicit.
What you can do after
Apply via a team-defined signal system to mark blocking status, requested effort, conventions, and optional improvements.
How it connects
Connects comment signals with code review comments, MoSCoW comments, Conventional Comments, and outcome-focused requests.

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.