(AI) Update schema guidance for code review - #1715
Merged
Steve Lee (SteveL-MSFT) merged 1 commit intoSep 15, 2026
Merged
Steve Lee (SteveL-MSFT) merged 1 commit into
Steve Lee (SteveL-MSFT) merged 1 commit into
Conversation
Copilot started reviewing on behalf of
Mikey Lombardi (He/Him) (michaeltlombardi)
September 10, 2026 15:26
View session
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new guidance contains Markdown formatting and Rust attribute syntax issues that could mislead reviewers and break rendered instructions.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR extends the repository’s AI-assisted code review guidance for DSC libraries and resources, focusing on best practices around defining types that derive JsonSchema and authoring resource JSON Schemas/manifests.
Changes:
- Added resource-schema guidance around canonical properties and
readOnly/writeOnlyusage. - Added library guidance for when to inline schemas vs. derive
DscRepoSchema, and when to apply schema transforms for enums.
File summaries
| File | Description |
|---|---|
| .github/instructions/code-review/resource.instructions.md | Adds resource manifest/schema review guidance (canonical properties, readOnly/writeOnly). |
| .github/instructions/code-review/library.instructions.md | Adds library schema/type guidance (inlining, DscRepoSchema, enum transforms). |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Mikey Lombardi (He/Him) (michaeltlombardi)
force-pushed
the
maint/main/update-schema-guidance-for-code-review
branch
from
September 15, 2026 15:15
81fd674 to
ca27cc9
Compare
This change extends the guidance for library and resources to clarify some best practices for defining types and JSON Schemas. The guidance centers on ensuring we correctly define resource schemas and follow best practices for types defined in the library crates that need to derive `JsonSchema`.
Mikey Lombardi (He/Him) (michaeltlombardi)
force-pushed
the
maint/main/update-schema-guidance-for-code-review
branch
from
September 15, 2026 16:30
ca27cc9 to
ae58fdf
Compare
Mikey Lombardi (He/Him) (michaeltlombardi)
requested review from
Steve Lee (SteveL-MSFT) and
Tess Gauthier (tgauth)
September 15, 2026 16:31
Steve Lee (SteveL-MSFT)
approved these changes
Sep 15, 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.
PR Summary
This change extends the guidance for library and resources to clarify some best practices for defining types and JSON Schemas. The guidance centers on ensuring we correctly define resource schemas and follow best practices for types defined in the library crates that need to derive
JsonSchema.PR Context
Adding guidance to AI review to make common schema feedback built into the automated review cycle instead of relying on guidance from specific reviewers who may not review a PR or might forget one or more items in the guidance.