Skip to content

fix(agents): fix plugin compatibility and robustness for coding-standards code review agents#1289

Merged
WilliamBerryiii merged 6 commits intomicrosoft:mainfrom
erikschlegel:fix/code-review-file-refs
Apr 6, 2026
Merged

fix(agents): fix plugin compatibility and robustness for coding-standards code review agents#1289
WilliamBerryiii merged 6 commits intomicrosoft:mainfrom
erikschlegel:fix/code-review-file-refs

Conversation

@erikschlegel
Copy link
Copy Markdown
Contributor

@erikschlegel erikschlegel commented Apr 3, 2026

Related Issue(s)

Fixes #1286

Description

These changes were discovered while testing the Code Review Standards and Code Review Full agents from the Coding Standards Plugin installation in VS Code. The plugin install surface exposed three categories of silent failure invisible when running the agents directly from the plugin.

Three commits fix path resolution failures, reference correctness, and agent robustness.

Commit 1 — correct review-artifacts path in Step 4

The #file: reference in code-review-standards.agent.md Step 4 pointed to ../../instructions/code-review/review-artifacts.instructions.md, missing the coding-standards/ path segment. Corrected to ../../instructions/coding-standards/code-review/review-artifacts.instructions.md.

Commit 2 — fix plugin compatibility for coding-standards skill resolution

The plugin generator strips the .github/ prefix from all artifact paths. An agent at .github/agents/coding-standards/ (3 levels deep in the repo) becomes agents/coding-standards/ (2 levels deep in the plugin), breaking any reference that assumed .github/ depth.

docs/templates/ relative links escape the plugin root. #file:../../../docs/templates/ worked in the repo but escaped the plugin root entirely. Converted to workspace-root prose (at `docs/templates/file.md`), consistent with adr-creation, brd-builder, and system-architecture-reviewer.

Skill loading failed entirely in plugin context.
Steps 3b and 3c assumed .github/skills/ prefix. Skills live under skills/ in the plugin. Both steps now use a dual path fallback: try .github/skills/... first, fall back to skills/....

pr-reference skill missing from the coding-standards collection.
The diff computation protocol relies on scripts in pr-reference, absent from coding-standards.collection.yml. Added so diff computation works for coding-standards-only plugin users.

Commit 3 — improve robustness of code review agents

code-review-full.agent.md:

  • Documented the disable-model-invocation / Step 4 interaction: manual invocation retains full model reasoning; added verbatim-output fallback with ⚠️ warning when transformation rules cannot be applied
  • Replaced vague "instruct it to skip" with prescribed skip phrases in Steps 2 and 3 so subagent skip behavior is deterministic
  • Defined fallback sources for standards-exclusive report sections (metadata description, Recommended Actions, Risk Assessment) for when the standards subagent is skipped
  • Added ## Error Recovery section covering diff failure, subagent failure, malformed output, persistence failure, and clarifying-question deadlock

code-review-standards.agent.md:

  • Changed template references from passive "Follow" to active "Read and use" with missing-file recovery language for consumer workspaces where docs/ may be absent

Related Issue(s)

Fixes #

Type of Change

Code & Documentation:

  • Bug fix (non-breaking change fixing an issue)

AI Artifacts:

  • Copilot agent (.github/agents/*.agent.md)
  • Copilot skill (.github/skills/*/SKILL.md)

Sample Prompts (for AI Artifact Contributions)

User Request:

"Review my current branch changes against our Python coding standards."

Execution Flow:

  1. Agent computes diff using pr-reference scripts (now packaged in the collection)
  2. Step 3b reads python-foundational SKILL.md from .github/skills/... (repo) or skills/... (plugin)
  3. Step 3c discovers consumer skills under .github/skills/ or skills/ depending on context
  4. Reads report template from docs/templates/standards-review-output-format.md; recovers gracefully if absent
  5. Findings persisted via corrected review-artifacts.instructions.md path

Success Indicators:
Skills are loaded and cited in findings. Report template is read from disk. Behavior is identical from repo or plugin install. No "skill unavailable" warnings for python-foundational.

Testing

  • Validated end-to-end from the Coding Standards Plugin installation in VS Code, which surfaced all three failure categories
  • Verified dual-path fallback text present at Steps 3b and 3c via grep
  • Confirmed pr-reference symlink at plugins/coding-standards/skills/shared/pr-reference
  • Ran npm run plugin:generate, plugin:validate, lint:md, and lint:frontmatter — all passed with 0 errors

Checklist

Required Checks

  • Documentation is updated (if applicable)

…tep 4

The #file: reference was missing the coding-standards/ segment,
pointing to instructions/code-review/ instead of
instructions/coding-standards/code-review/.
…lution

- Convert docs/templates references from relative paths to workspace-root
  prose pattern (matching adr-creation, brd-builder, system-architecture-
  reviewer convention) — ensures resolution works in both repo and plugin
  contexts where .github/ prefix stripping shifts relative depth

- Fix Step 3b skill catalog path: try .github/skills/ first, fall back to
  skills/ for plugin/extension compatibility

- Fix Step 3c skill discovery scope: search .github/skills/ if exists,
  otherwise skills/ — ensures consumer skill discovery works in plugin

- Add pr-reference skill to coding-standards collection so diff-computation
  scripts are available to coding-standards-only plugin users

- Delete orphaned foundational-coding-guidelines.md from python-foundational
  references/ (duplicate of design-principles.md; not in SKILL.md table)
@erikschlegel erikschlegel self-assigned this Apr 3, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.71%. Comparing base (6e4ea2e) to head (448c9fb).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1289      +/-   ##
==========================================
- Coverage   87.72%   87.71%   -0.02%     
==========================================
  Files          61       61              
  Lines        9320     9320              
==========================================
- Hits         8176     8175       -1     
- Misses       1144     1145       +1     
Flag Coverage Δ
pester 85.31% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

code-review-full:
- Document disable-model-invocation / Step 4 interaction; add verbatim
  fallback with warning when transformation rules cannot be applied
- Replace vague 'instruct it to skip' with prescribed skip phrases for
  both subagent invocations so skip behavior is deterministic
- Define fallback sources for standards-exclusive report sections
  (metadata description, Recommended Actions, Risk Assessment) when
  the standards subagent is skipped
- Add Error Recovery section covering diff failure, subagent failure,
  malformed output, persistence failure, and clarifying-question deadlock

code-review-standards:
- Change template references from passive 'Follow' to active 'Read and
  use' with missing-file recovery language for consumer workspaces where
  docs/ may be absent
@erikschlegel erikschlegel marked this pull request as ready for review April 3, 2026 09:57
@erikschlegel erikschlegel requested a review from a team as a code owner April 3, 2026 09:57
@erikschlegel erikschlegel changed the title Fix/code review file refs fix(agents): fix plugin compatibility and robustness for coding-standards code review agents Apr 3, 2026
Copy link
Copy Markdown
Contributor

@katriendg katriendg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for these updates, I left a few comments if we can still finetune the skills discovery to be left over at the platform level and not file location (which is how we expect this should work). Wdyt?

Note in the issue comment you mention you deleted the orphaned file but I don't seen any deletionn?

Comment thread .github/agents/coding-standards/code-review-standards.agent.md Outdated
Comment thread .github/agents/coding-standards/code-review-standards.agent.md Outdated
Comment thread .github/agents/coding-standards/code-review-standards.agent.md
…Steps 3b and 3c

Replace path-based skill resolution with platform-discoverable skill matching
to ensure portability across repo, extension, and plugin install contexts.
@erikschlegel
Copy link
Copy Markdown
Contributor Author

Note in the issue comment you mention you deleted the orphaned file but I don't seen any deletionn?

This was related to a PR fix that was merged yesterday

@erikschlegel
Copy link
Copy Markdown
Contributor Author

erikschlegel commented Apr 3, 2026

Good call @katriendg - I implemented your suggestions from the last review. LMK if those look good?

@erikschlegel erikschlegel marked this pull request as draft April 3, 2026 20:30
@erikschlegel erikschlegel marked this pull request as ready for review April 6, 2026 01:07
@erikschlegel
Copy link
Copy Markdown
Contributor Author

This PR is now ready to be merged @katriendg

@WilliamBerryiii WilliamBerryiii merged commit 8319d10 into microsoft:main Apr 6, 2026
40 checks passed
WilliamBerryiii pushed a commit that referenced this pull request Apr 24, 2026
## Pre-Release 3.3.101

### ✨ Features

- add removed maturity tier and retire owasp-docker (#1444)
- add evaluation dataset creator (#1279)
- align RAI planner with guide, remove scoring, improve UX (#1287)
- add PSGallery staleness check and BOM cleanup (#1379)
- ISA-95 network planner agent (#1177)
- auto-generate collection.md with maturity filtering (#1316)
- add folder-consistency check and standardize WARN outp… (#1350)
- add synth-data-generate prompt to data-science collection (#1419)
- add canonical deck workflow and customer-card rendering for design
thinking (#1413)
- add Figma MCP integration for DT artifact export (#1222)
- introduce `owasp-docker` (#1245)
- replace hve-core-specific references with portable discovery-based
language (#1335)
- introduce `owasp-cicd` (#1246)
- add secure-by-design knowledge skill (#1223)
- introduce `owasp-infrastructure` (#1244)
- introduce `owasp-mcp` (#1207)
- add OutputPath parameter to Invoke-LinkLanguageCheck.ps1 (#1229)
- add -OutputPath parameter to Validate-SkillStructure.ps1 (#1225)
- add maintainer-only skip-review label guard (#1293)
- add extension collections overview and integrate into getting started
flow (#950)
- add agentic workflows for automated issue triage, implementation, PR
review, dependency review, and doc-staleness detection (#1219)
- consolidate package-lock.json version sync into
Update-VersionFiles.ps1 (#1240)
- add standards code review agent and full review orchestrator (#1174)
- standardize pytest-mock as Python mocking framework (#1170)
- add Jira backlog workflows and Jira/GitLab skills (#978)
- add centralized version bump script and supply-chain attestation
(#1183)

### 🐛 Bug Fixes

- pin PowerShell-Yaml to 0.4.7 across all install sites (#1378)
- close fork-PR/workflow-file-PR secret-strip gap and normalize
upload-artifact version (#1421)
- replace stream-based lookahead with array indexing in
list-changed-files.sh (#1376)
- centralize ISO 8601 timestamp regex in CIHelpers (#1343)
- update stale documentation date in release-process.md (#1363)
- pin basic-ftp to 5.3.0 to resolve GHSA-rp42-5vxx-qpwr (#1374)
- add bot filter to dependency PR review workflow (#1362)
- resolve pip-audit findings in powerpoint, gitlab, and jira skill lock
files (#1360)
- standardize Timestamp JSON key casing across all lint result files
(#1314)
- add synchronize trigger to PR Review workflow (#1323)
- standardize timestamp in Validate-SkillStructure.ps1 to use
Get-StandardTimestamp (#1280)
- add parallel subagent dispatch and structured JSON contracts to
code-review-full (#1304)
- standardize timestamp in SecurityHelpers.psm1 to use
Get-StandardTimestamp (#1284)
- standardize timestamps in Test-DependencyPinning.ps1 and
SecurityClasses.psm1 (#1282)
- derive collection artifact counts from YAML at build time (#1275)
- standardize timestamp in FrontmatterValidation.psm1 to use
Get-StandardTimestamp (#1285)
- standardize timestamp in Markdown-Link-Check.ps1 to use
Get-StandardTimestamp (#1283)
- escape hyphens in Mermaid diagram on Collections page (#1262)
- add summary timestamp to PSScriptAnalyzer output (#1211)
- fix plugin compatibility and robustness for coding-standards code
review agents (#1289)
- standardize timestamp in Test-CopyrightHeaders.ps1 to use
Get-StandardTimestamp (#1278)
- standardize timestamp in Invoke-YamlLint.ps1 to use
Get-StandardTimestamp (#1270)
- standardize timestamp in Invoke-LinkLanguageCheck.ps1 to use
Get-StandardTimestamp (#1264)
- fix dependency-review path filters and sparse-checkout cone mode
(#1259)
- replace invalid bare tool names with official tool identifiers (#1198)
- fix broken links and remove orphaned reference in code review docs
(#1257)
- exclude Python env dirs from skill validation warnings (#1255)
- pin happy-dom and serialize-javascript to resolve Dependabot
vulnerabilities (#1253)
- remove Mermaid diagram and add missing collection cards (#1247)
- disable MCP servers by default to prevent token limit errors (#1144)
- sync package-lock.json after pre-release version bump (#1236)
- separate mermaid node declarations and add dynamic diagram generation
with tests (#1215)
- replace anchor links in meeting-analyst with bold text references
(#1201)
- remove recursive symlinks in jira and gitlab skill directories (#1233)
- validate-installation scripts now check .github/skills directory
(#1010) (#1206)
- resolve npm audit vulnerabilities via dependency overrides (#1200)
- add post-release triggers to scorecard workflow (#1186)
- add missing .md extensions to relative links in agent documentation
(#1180)

### 📚 Documentation

- broaden Security Review description beyond OWASP (#1385)
- document maintainer advisory mode and skip-review label guard (#1386)
- document ExcludePaths/OutputPath for Invoke-LinkLanguageCheck (#1383)
- CLI getting-started: clarify plugin install commands as alternatives
(-all vs base) (#1251)

### ♻️ Refactoring

- align agent and prompt folder names to collection identifier (#1210)

### 🔧 Maintenance

- pin PSScriptAnalyzer to 1.25.0 and sync stale workflow version
comments (#1389)
- bump lxml from 6.0.2 to 6.1.0 in
/.github/skills/experimental/powerpoint (#1424)
- bump @vscode/vsce from 3.7.1 to 3.9.1 in the npm-dependencies group
(#1390)
- bump the github-actions group across 1 directory with 7 updates
(#1391)
- bump follow-redirects from 1.15.11 to 1.16.0 in /docs/docusaurus
(#1356)
- upgrade Node.js from 20 to 24 and bump cspell to v10 (#1353)
- bump basic-ftp from 5.2.0 to 5.2.1 (#1324)
- update github/gh-aw-actions requirement to
536ea1bad8c6715d098a9dc1afea8d403733acfe in the github-actions group
across 1 directory (#1298)
- update security instruction attributions and compliance (#1294)
- bump the npm-dependencies group with 2 updates (#1297)
- pre-release 3.3.41 (#1252)
- streamline RAI Planner phase structure and documentation (#1273)
- bump happy-dom from 20.8.8 to 20.8.9 in /docs/docusaurus (#1237)
- pre-release 3.3.27 (#1191)
- bump pygments from 2.19.2 to 2.20.0 in /.github/skills/gitlab/gitlab
(#1234)
- bump path-to-regexp from 0.1.12 to 0.1.13 in /docs/docusaurus (#1226)
- bump the github-actions group with 4 updates (#1231)
- add missing folders and alphabetize location lists (#1193)
- bump brace-expansion (#1224)
- bump handlebars from 4.7.8 to 4.7.9 in /docs/docusaurus (#1217)
- bump brace-expansion from 5.0.3 to 5.0.5 in /docs/docusaurus (#1213)
- pre-release 3.3.10 (#1187)
- bump markdownlint-cli2 from 0.21.0 to 0.22.0 in the npm-dependencies
group (#1175)
- bump the github-actions group with 3 updates (#1176)
- pre-release 3.3.1 (#1165)

---
*Managed automatically by pre-release workflow.*

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: Code Review Standards agent: skill loading and template references fail silently in plugin/extension context

5 participants