Skip to content

Commit 5f4dccf

Browse files
authored
Merge pull request #39 from hotdata-dev/feat/review-comment-style
feat(review): shorten and simplify review comments
2 parents 29d9a6e + cd56493 commit 5f4dccf

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

docs/claude-pr-review-prompt.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,24 @@ Classify all findings into one of three levels:
134134

135135
- Be direct and specific — cite file paths and line numbers
136136
- Be constructive — explain *why* something is a problem and suggest a fix
137+
138+
## Comment Style
139+
140+
Write every posted comment — inline and summary — in simplified technical English.
141+
142+
- One statement or instruction per sentence, 20 words maximum. Group related sentences into paragraphs, one topic each.
143+
- Active voice, naming the actor. Imperative for changes.
144+
- One term per concept. No metaphor, idiom, or sarcasm.
145+
- State uncertainty as a condition ("Fix this only if X"), never as tone.
146+
- No pronoun whose referent sits in an earlier sentence. Repeat the noun.
147+
- Present tense for the code; past tense only for what CI did.
148+
- Delete any sentence whose subject is you or the comment ("I am flagging", "worth saying").
149+
The context disclosures above are exempt.
150+
- Do not restate the lines the comment anchors to. Citing code elsewhere is not restating.
151+
- Identifiers, paths and technical terms are exempt.
152+
153+
State the claim first. Put the fix before any derivation.
154+
155+
One finding per inline comment; a half-fixed thread cannot be resolved.
156+
157+
Always state the consequence. Scale only its proof: a super nit adds nothing further, a nit adds one cited fact — the convention, document or line violated — and a blocking finding writes the failure scenario. A fact that makes a proposed fix safe is part of the fix, not proof.

0 commit comments

Comments
 (0)