Clarify Components code documentation guidance - #68345
Merged
PureWeen merged 2 commits intoAug 11, 2026
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 0fb5ea3b-44bb-495b-99c5-93e753ca9ce1
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 0fb5ea3b-44bb-495b-99c5-93e753ca9ce1
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Components area contributor guidance to emphasize code clarity through structure (names, extracted methods, single-responsibility units) before adding implementation comments, and to keep public XML docs focused on consumer-observable behavior rather than internal mechanics.
Changes:
- Adds a new “Code clarity and durable knowledge” section encouraging structural clarity over narrative comments.
- Specifies when implementation comments are appropriate (durable, non-local reasons such as cross-boundary ordering or compatibility constraints).
- Clarifies that public XML documentation should avoid internal control-flow/lifecycle details and instead describe observable behavior.
Show a summary per file
| File | Description |
|---|---|
| src/Components/AGENTS.md | Adds durable guidance on preferring structural clarity over comments and constrains public XML docs to consumer-facing behavior. |
Review details
Tip
Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
ilonatommy
approved these changes
Aug 11, 2026
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.
Summary
This follows the guidance discussed in #68114 (comment) and #68114 (comment).
Validation
Documentation-only change;
git diff --checkpasses.