Skip to content

docs: copilot-instructions.md - Emphasize XML doc review#3009

Merged
Eideren merged 3 commits intostride3d:masterfrom
VaclavElias:feat-copilot-instructions-update
Mar 15, 2026
Merged

docs: copilot-instructions.md - Emphasize XML doc review#3009
Eideren merged 3 commits intostride3d:masterfrom
VaclavElias:feat-copilot-instructions-update

Conversation

@VaclavElias
Copy link
Copy Markdown
Contributor

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

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have built and run the editor to try this change out.

docs: copilot-instructions.md - Emphasize XML doc review

  • Instruct reviewers to always check for missing, incomplete, or incorrect XML documentation on public APIs.

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.

  • copilot-instructions.md: Added detailed guidelines for reviewing, suggesting, and maintaining XML documentation comments on public types and members.

- Instruct reviewers to always check for missing, incomplete, or incorrect XML documentation on public APIs.
@VaclavElias VaclavElias added the area-Doc Issues related to documentation and XML comments label Dec 13, 2025
@Eideren Eideren merged commit a15fdd4 into stride3d:master Mar 15, 2026
2 checks passed
@Eideren
Copy link
Copy Markdown
Collaborator

Eideren commented Mar 15, 2026

Thanks !

@VaclavElias
Copy link
Copy Markdown
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.

@VaclavElias VaclavElias deleted the feat-copilot-instructions-update branch April 19, 2026 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-Doc Issues related to documentation and XML comments

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants