Add agent-assisted AI-artifact upkeep check#55204
Open
mthalman wants to merge 1 commit into
Open
Conversation
When a change alters something an AI- or contributor-facing artifact describes, the matching artifact should be updated in the same PR. This adds authoring-time guidance for agents and a review-time check so stale instructions, docs, AGENTS.md, and skills get surfaced when a change invalidates them. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
42 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds explicit guidance and review criteria to help keep contributor- and AI-facing artifacts (instructions, skills, docs) synchronized with behavioral/code changes, so drift is surfaced during authoring and code review.
Changes:
- Extend the code review skill checklist to include “stale AI context / instructions / docs” as an explicit issue category.
- Add a new section to
.github/copilot-instructions.mdreminding contributors/agents to update related artifacts in the same PR when changes invalidate documented guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/skills/code-review/SKILL.md | Adds an explicit checklist item to flag stale AI/contributor-facing artifacts when code changes invalidate them. |
| .github/copilot-instructions.md | Adds a new “Keeping AI context and docs in sync” section with concrete artifact locations to check/update. |
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.
When a change alters something an AI- or contributor-facing artifact describes, the matching artifact should be updated in the same PR. This adds authoring-time guidance for agents and a review-time check so stale instructions, docs, AGENTS.md, and skills get surfaced when a change invalidates them.