Skip to content

Commit bfd1f6b

Browse files
tnorlingCopilot
andauthored
Update Copilot PR Review instructions (#8146)
Copilot PR reviewer isn't always leaving code suggestions, updating the instructions file to nudge Copilot to use this feature more often. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 1691947 commit bfd1f6b

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

.github/copilot-instructions.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,3 +419,44 @@ samples/*/test/ # Sample application tests
419419
**Specific Areas to Focus On:**
420420

421421
When reviewing, provide specific, actionable suggestions with code examples where helpful. Focus on maintainability, security, performance, and user experience.
422+
423+
### Code Suggestion Guidelines
424+
425+
#### Always Provide Code Suggestions When Applicable
426+
427+
**IMPORTANT: Use GitHub's code suggestion feature (i.e., suggestion code blocks) instead of plain text descriptions whenever possible.**
428+
429+
This allows PR authors to accept suggestions with a single click, making reviews more efficient.
430+
431+
#### When to Use Code Suggestions
432+
433+
**Always use code suggestions for:**
434+
- Formatting issues (indentation, spacing, line breaks, JSON/YAML formatting)
435+
- Simple fixes (typos, missing semicolons, incorrect imports)
436+
- Standard patterns (changefile format, conventional commits, linting rules)
437+
- Refactoring suggestions for small code blocks
438+
- Any change that can be directly applied to the code
439+
440+
**Examples:**
441+
- Changefile format issues → Provide corrected JSON as a suggestion
442+
- Import statement errors → Suggest the correct import
443+
- Formatting inconsistencies → Suggest properly formatted code
444+
- Simple bug fixes → Suggest the fix
445+
446+
#### When to Use Text Comments
447+
448+
**Use text comments (not code suggestions) for:**
449+
- Design discussions or architectural questions
450+
- Multiple alternative approaches
451+
- Questions requiring clarification from the author
452+
- Complex changes requiring significant context or explanation
453+
- Issues that span multiple files or locations
454+
455+
### Code Suggestion Best Practices
456+
457+
1. **Be specific**: Each suggestion should target a specific issue
458+
2. **Include context**: Briefly explain why the change is needed
459+
3. **Keep it simple**: Break complex changes into multiple suggestions
460+
4. **Link documentation**: Reference relevant docs or standards when applicable
461+
5. **Suggest liberally**: Code suggestions are easy to accept or decline
462+

0 commit comments

Comments
 (0)