Repository navigation
Add "edit criteria" for AI doc updates - #85893
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
mwiemer-microsoft
changed the title
mwiemer-microsoft
marked this pull request as ready for review
October 2, 2026 16:51
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation-only changes are coherent, complete, and introduce no unresolved issues.
Review effort: Balanced
Findings: None
What changed in this PR
Clarifies that agent-documentation assessment is mandatory, while edits are required only when specific criteria are met.
Changes:
- Defines documentation edit and “no edit” criteria.
- Aligns the repository instructions and documentation skill.
- Preserves mandatory API, diagnostic, and resource updates.
Holistic assessment: The change is focused, internally consistent, and directly supports the stated goal of reducing low-value documentation edits.
| File | Description |
|---|---|
.github/skills/update-agent-docs/SKILL.md |
Adds assessment criteria and refines the checklist. |
.github/copilot-instructions.md |
Aligns repository-wide documentation guidance. |
jasonmalinowski
approved these changes
Oct 2, 2026
333fred
reviewed
Oct 2, 2026
| **Necessary guidance for a new pattern missing?** → If it meets the edit criteria, document it in `.github/memory/CONVENTIONS.md` for repo-wide guidance or the matching `.github/instructions/<area>.instructions.md` for layer-specific guidance. | ||
|
|
||
| **Surprising or undocumented behavior found?** → Ask the user how they want it documented. | ||
| **Surprising or undocumented behavior found?** → Assess whether it meets the edit criteria. Ask the user only when a necessary documentation decision cannot be made confidently. |
Member
There was a problem hiding this comment.
Let's also add a line about documenting workarounds for known issues inline, rather than in the knowledge base. IE, if an msbuild issue is encountered and needs some task override, the issue should be documented right at that override, not in the repo knowledge base.
Member
Author
There was a problem hiding this comment.
sry, will handle in followup
This was referenced Oct 2, 2026
333fred
added a commit
that referenced
this pull request
Oct 2, 2026
# By Sam Harwell (331) and others # Via GitHub (414) and others * upstream/main: (1352 commits) Document known issue workarounds inline (#85896) Restore automatic HTML test results for local runs (#85892) Report actual errors when strong-name HRESULT assertions fail (#85894) Restore main insertions after the VS 18.12 snap (#85824) Add "edit criteria" for AI doc updates (#85893) Handle cref type parameters in symbol lookup (#85840) Fix build warnings (#85754) Improve our Copilot instructions for testing [main] Update dependencies from dotnet/arcade (#85885) Rewrite 'router' phrasing Address review feedback Add option to disable cref paste fix Prefer repository terminology in generated output (#85878) Use cref for workspace extension handler Remove unnecessary static diagnostic registration Unsafe evolution: use safety documentation for unnecessary unsafe (#85842) Add Razor compiler team to code owners Unsafe evolution: avoid constructor recursion (#85773) Add roslyn-ide to Razor code owners Fix unexpected System.ArrayTypeMismatchException for captured method call receivers (#85811) ... Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: fd482dbd-c828-466b-87c6-6b2103be2089 # Conflicts: # src/Compilers/CSharp/Portable/Errors/ErrorCode.cs # src/Compilers/CSharp/Portable/Errors/MessageID.cs
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.
Our goal is to reduce low-quality doc edits. Previous instructions encouraged action; new instructions encourage analysis and provide a "no edit" escape hatch explicitly.
Microsoft Reviewers: Open in CodeFlow