Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VaclavElias wants to merge 3 commits into
base: master
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c237b75
Fix ShipComponent to manually apply drag instead of using non-existen…
VaclavElias Dec 13, 2025
a31ea82
Delete sources/engine/Stride.BepuPhysics/Stride.BepuPhysics/ShipCompo…
VaclavElias Dec 13, 2025
ea6ffa5
docs: copilot-instructions.md - Emphasize XML doc review
VaclavElias Dec 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,13 @@ Stride is a game engine project that requires careful code reviews to maintain q
- If you find a bug or performance issue, suggest a concrete fix in the PR.
- For large PRs (20+ C#/*.cs files), do not attempt a full review, only highlight critical or blocking issues.
- Always consider the context and established patterns in the Stride codebase before making suggestions.
- **Always check for missing, incomplete, or incorrect XML documentation comments** on public types, methods, properties, and fields.
- **Provide XML comment suggestions as individual, separate items** so they can be reviewed and approved independently.
- **Do not rewrite existing XML comments unless they contain errors** such as incorrect information, poor grammar, typos, or lack clarity. Preserve well-written documentation.
- When suggesting XML comments, ensure they are:
- Accurate and describe the actual functionality
- Consistent with existing documentation style in the codebase
- Include `<summary>`, `<param>`, `<returns>`, `<exception>` and `<remarks>` tags where appropriate
- Clear and helpful for API consumers

The goal is to minimize noise and maximize helpful, actionable feedback.