docs: copilot-instructions.md - Emphasize XML doc review#3009
Merged
Eideren merged 3 commits intostride3d:masterfrom Mar 15, 2026
Merged
docs: copilot-instructions.md - Emphasize XML doc review#3009Eideren merged 3 commits intostride3d:masterfrom
Eideren merged 3 commits intostride3d:masterfrom
Conversation
…t damping properties
- Instruct reviewers to always check for missing, incomplete, or incorrect XML documentation on public APIs.
Kryptos-FR
approved these changes
Dec 30, 2025
Collaborator
|
Thanks ! |
Contributor
Author
|
@Eideren, @Kryptos-FR my instructions are neutral but feel free to update this for Stride context itself. It might help others when they run their copilot reviews in their forks. I believe you can beef up this file with more context. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Details
If we are going to use Copilot for reviews, it would be good if we could get also xml comments suggestions because these are vital for our game engine project.
This is the same PR as before (now closed), which was in the incorrect location in my local repo.
Related Issue
Types of changes
Checklist
docs: copilot-instructions.md - Emphasize XML doc review
PR Classification
Documentation update to improve code review guidelines.
PR Summary
This pull request updates copilot-instructions.md to strengthen requirements for XML documentation in code reviews. It introduces explicit instructions for reviewers to check and suggest XML comments on public APIs.