GitHub Issue & PR Comment Guidelines

Anti-Patterns (Avoid These)

• Over-structured responses: Don't use headers, numbered sections, or bullet lists for simple replies. A conversational paragraph is usually better.
• Formulaic openings: Don't start every comment identically. Match the tone to the conversation.
• Restating what's obvious: If someone asked a question, just answer it. Don't recap what they said.
• Corporate announcements: "We are pleased to announce..."; just say what changed.
• Over-explaining closed-loop fixes: If the issue is fixed and there is no action needed from the reporter, do not make them read release-process details.

Follow writing-voice for tone.

Maintainer Respect Gate

Assume issue reporters and maintainers are busy. The most respectful comment is usually the shortest one that closes the loop clearly.

Comment Compression Rule

Before drafting, ask: what does the reader need to know or do next? Include only that.