PR Comment Workflow

Procedural knowledge for writing and responding to PR review comments.

Comment Style Rules

• lowercase start for all sentences
• never use em-dashes (—, –, --) between sentences, expressions, examples, or terms. Use commas, periods, or "or" instead
• no complex sentences
• simple terms, concise
• no end-of-sentence punctuation if possible
• max 1 sentence or shorter per comment
• polite when responding to real people
• bot comments: single concise sentence, no pleasantries ("good catch", "nice find", "thanks"), just state the fact directly

Review Comment Rules