Skip to content

Commit a15fdd4

Browse files
authored
docs: copilot-instructions.md - Emphasize XML doc review (#3009)
1 parent 34501f9 commit a15fdd4

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

.github/copilot-instructions.md

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

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

0 commit comments

Comments
 (0)