Skip to content

Commit 9ca00e5

Browse files
XS ◾ Update rule.mdx (#11761)
<!-- **Tip: Use [SSW Rule Writer GPT](https://chat.openai.com/g/g-cOvrRzEnU-ssw-rules-writer) for help with writing rules 🤖** --> > > 1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc) ✏️ @tiagov8 comments on #11744 (comment) > 2. What was changed? ✏️ resolving code comments > 3. I paired or mob programmed with: <!-- list names or remove if not relevant --> ✏️ solo <!-- E.g. I paired or mob programmed with: @GordonBeeming and @sethdailyssw --> <!-- Check out the relevant rules - https://www.ssw.com.au/rules/rules-to-better-pull-requests - https://www.ssw.com.au/rules/write-a-good-pull-request - https://www.ssw.com.au/rules/over-the-shoulder-prs - https://www.ssw.com.au/rules/do-you-use-co-creation-patterns --> --------- Co-authored-by: Tom Iwainski <tomiwainski@ssw.com.au>
1 parent 7b8ac31 commit 9ca00e5

File tree

1 file changed

+33
-41
lines changed
  • public/uploads/rules/resolving-code-review-comments

1 file changed

+33
-41
lines changed

public/uploads/rules/resolving-code-review-comments/rule.mdx

Lines changed: 33 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -30,51 +30,20 @@ archivedreason: null
3030
When someone leaves a comment or GitHub Copilot creates a comment on your pull request, it's tempting to simply mark it as resolved and move on.
3131
However, this creates confusion for other reviewers who can't tell if the suggestion was implemented, why it wasn't implemented, or what the outcome was.
3232

33-
Just like the "Reply Done" principle for emails, you should always provide a clear response to code review comments before resolving them.
33+
Just like the ["Reply Done"](https://www.ssw.com.au/rules/reply-done) principle for emails, you should always provide a clear response to code review comments before resolving them.
3434
This helps maintain transparency and ensures all reviewers understand the resolution.
3535

3636
<endIntro _hidden="" />
3737

38-
## Always respond before resolving
38+
## How to respond to different types of comments
3939

40-
When you address a comment in your pull request, you should:
41-
42-
1. **For change requests**: Implement the change and reply "Done" or explain why it will not be implemented
43-
2. **For questions**: Reply without resolving to allow conversation continuation
44-
45-
## Bad examples
46-
47-
<imageEmbed alt="Image" size="small" showBorder={false} figurePrefix="bad" figure="AI Suggestion marked as resolved with no response" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20115911.png" />
48-
49-
<imageEmbed alt="Bad Example - Comment simply marked as resolved with no response" size="small" showBorder={false} figurePrefix="bad" figure="Comment simply marked as resolved with no response" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20165155.png" />
50-
51-
## Good examples
52-
53-
<imageEmbed alt="Image" size="small" showBorder={false} figurePrefix="good" figure="Clear confirmation that the change was implemented" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20172623.png" />
54-
55-
<imageEmbed alt="Image" size="small" showBorder={false} figurePrefix="good" figure="Explained that the change will be addressed in a separate PBI" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20175826.png" />
56-
57-
## Why this matters
58-
59-
### For other reviewers
60-
61-
* **Clarity**: They can quickly see which suggestions were implemented and why others weren't
62-
* **Efficiency**: No need to manually compare code to understand what changed
63-
* **Learning**: Understanding why certain suggestions were rejected provides valuable context
64-
65-
### For the PR author
66-
67-
* **Documentation**: Creates a clear record of decisions made during the review
68-
* **Accountability**: Shows you've carefully considered all feedback
69-
* **Communication**: Demonstrates respect for the reviewer's time and input
70-
71-
## Handling different types of comments
40+
When you address a comment in your pull request, the response depends on the type of comment:
7241

7342
### For **"Change"** comments
7443

7544
These are typically blocking requests that must be addressed. Always respond with:
7645

77-
* "**✅ Done**"
46+
* "**✅ Done**" - after implementing the change
7847
* "**❌ Won't do** - reason why the change isn't being made"
7948

8049
### For **"Question"** comments
@@ -85,19 +54,42 @@ Reply without resolving so the author can read it and continue the conversation:
8554
* "Yes, that's handled in the validation layer"
8655
* "Good point - let me clarify..."
8756

88-
If theres a disagreement, its generally best to discuss it in person (or offline) rather than through comments, when possible. Once aligned, summarize the outcome in the thread for visibility, e.g.:
57+
If there's a disagreement, it's generally best to discuss it in person (or offline) rather than through comments, when possible. Once aligned, summarize the outcome in the thread for visibility, e.g.:
8958

9059
* "As per my conversation with @person, we agreed that …"
9160

9261
Only mark questions as resolved after the conversation is complete and both parties agree.
9362

63+
<imageEmbed alt="Image" size="small" showBorder={false} figurePrefix="bad" figure="AI Suggestion marked as resolved with no response" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20115911.png" />
64+
65+
<imageEmbed alt="Bad Example - Comment simply marked as resolved with no response" size="small" showBorder={false} figurePrefix="bad" figure="Comment simply marked as resolved with no response" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20165155.png" />
66+
67+
<imageEmbed alt="Image" size="small" showBorder={false} figurePrefix="good" figure="Clear confirmation that the change was implemented" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20172623.png" />
68+
69+
<imageEmbed alt="Image" size="small" showBorder={false} figurePrefix="good" figure="Explained that the change will be addressed in a separate PBI" src="/uploads/rules/do-you-properly-resolve-code-review-comments/Screenshot%202026-01-22%20175826.png" />
70+
71+
## Why this matters
72+
73+
### For other reviewers
74+
75+
* **Clarity** - They can quickly see which suggestions were implemented and why others weren't
76+
* **Efficiency** - No need to manually compare code to understand what changed
77+
* **Learning** - Understanding why certain suggestions were rejected provides valuable context
78+
79+
### For the PR author
80+
81+
* **Documentation** - Creates a clear record of decisions made during the review
82+
* **Accountability** - Shows you've carefully considered all feedback
83+
* **Communication** - Demonstrates respect for the reviewer's time and input
84+
85+
9486
## Best practices
9587

96-
1. **Be specific**: Reference exactly what you did in response to the comment
97-
2. **Include context**: Provide brief reasoning for your decisions
98-
3. **Use consistent formatting**: Start with the status (Done, Won't do, etc.)
99-
4. **Address all comments**: Don't leave any comment unresolved without a response
100-
5. **Keep it concise**: Provide enough detail without being overly verbose
88+
* **Be specific** - Reference exactly what you did in response to the comment
89+
* **Include context** - Provide brief reasoning for your decisions
90+
* **Use consistent formatting** - Start with the status (Done, Won't do, etc.)
91+
* **Address all comments** - Don't leave any comment unresolved without a response
92+
* **Keep it concise** - Provide enough detail without being overly verbose
10193

10294
By following these practices, you create a more transparent and efficient code review process that benefits everyone involved.
10395
The small extra effort of writing clear responses saves significant time and confusion for the entire team.

0 commit comments

Comments
 (0)