Skip to content

Commit a73d1ca

Browse files
CopilotPureWeen
andcommitted
Enhance copilot instructions for handling existing PRs - add flexibility and abandonment guidance
Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>
1 parent 845fb06 commit a73d1ca

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

.github/copilot-instructions.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,14 +168,18 @@ When working on an issue that already has an open PR created by someone else:
168168

169169
1. **Review the existing PR thoroughly** - Examine the proposed changes, implementation approach, and any discussion in comments
170170
2. **Provide analysis and opinion** - Evaluate whether the existing solution addresses the issue effectively and follows best practices
171-
3. **Use existing PR as foundation** - If the existing solution is valid, use it as the starting point and foundation for your work
172-
4. **Identify improvement opportunities** - Look for areas where you can enhance the solution, such as:
171+
3. **Always include a summary** - In your PR description, always include a summary of what you think about any other open PRs for the issue you are working on
172+
4. **Don't force using existing approach** - Don't try too hard to base your work off the existing PR if you're not confident in that approach
173+
5. **It's OK to abandon existing PRs** - If you're not confident enough in the existing PR's approach, it's completely acceptable to abandon it and implement a different solution
174+
6. **Document abandonment reasoning** - If you do abandon an existing PR approach, make sure to add clear notes explaining why you abandoned that approach and what concerns or issues you identified
175+
7. **Use existing PR as foundation when valid** - If the existing solution is solid and you're confident in the approach, use it as the starting point and foundation for your work
176+
8. **Identify improvement opportunities** - Look for areas where you can enhance the solution, such as:
173177
- Adding comprehensive test coverage
174178
- Improving code quality, performance, or maintainability
175179
- Enhancing error handling or edge case coverage
176180
- Better documentation or code comments
177181
- More robust implementation patterns
178-
5. **Build upon, don't duplicate** - Extend and improve the existing work rather than creating a competing solution from scratch
182+
9. **Build upon, don't duplicate** - When using an existing approach, extend and improve the existing work rather than creating a competing solution from scratch
179183

180184
### Branching
181185
- `main` - For bug fixes without API changes

0 commit comments

Comments
 (0)