feat(agents): document plain-text path convention for .copilot-tracking artifacts#2147
Conversation
…-subagent-file-references
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2147 +/- ##
==========================================
+ Coverage 81.28% 81.36% +0.07%
==========================================
Files 128 118 -10
Lines 18925 18849 -76
Branches 12 0 -12
==========================================
- Hits 15384 15336 -48
+ Misses 3538 3513 -25
+ Partials 3 0 -3
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
katriendg
left a comment
There was a problem hiding this comment.
Verdict: Approve with comments — clean, well-scoped documentation change. All 8 subagents now carry the File Reference Formatting section and the backtick/link cleanup is consistent. A few items to resolve before merge, plus one completeness check against the linked issue.
1. Issue alignment — confirm AC2 & AC3 before auto-close. This PR Closes #2018, whose acceptance criteria include "read-only subagents use the compact pointer response format consistently" (AC2) and "write subagents use the structured template response format consistently" (AC3). The PR delivers the file-reference-formatting and plain-text-path criteria (AC1, AC4) and de-backticks the pointer lines, but I don't see active standardization of the response formats into those two categories. If they were already consistent pre-PR, great — could you note that so closing the issue is accurate? Otherwise consider deferring AC2/AC3 to a follow-up.
2. Markdown lint does not actually cover these files. Heads-up that the "npm run lint:md passed" evidence doesn't validate the changed files: .markdownlint-cli2.jsonc ignores .github/instructions/**, .github/agents/**, .github/prompts/**, and .github/skills/**. I ran markdownlint directly against the PR version and it reports MD004/ul-style violations (see inline). Worth fixing manually since CI won't catch them.
Remaining nits are inline. Nice cleanup overall — the chat-vs-artifact boundary note is a good addition.
…ubagent prompts - replace em dashes with sentence breaks in File Reference Formatting sections - convert dash bullets to asterisks for MD004 compliance - label paired artifact and chat reference surfaces and add phase-implementor rationale 🔧 - Generated by Copilot
|
Verified — thanks for the thorough review. Confirming for the record:
So closing #2018 on merge is accurate. I verified the above, will resolve the threads and approve. Will just need a quick update with |
|
@vdstrizhkova - thanks for the help here ... mering it down! |
Description
Establishes a formal convention for file references written by subagents into
.copilot-tracking/artifacts. The key principle: when agents cite workspace files in artifact content, use plain-text workspace-relative paths — no markdown links, no#file:directives, no backticks. This prevents VS Code from resolving the paths and flooding the Problems tab with missing-target errors.The change introduces two complementary reference surfaces:
Changes
Subagent File Reference Formatting (8 files)
Added a new standardized
## File Reference Formattingsection to:.github/agents/hve-core/subagents/implementation-validator.agent.md.github/agents/hve-core/subagents/phase-implementor.agent.md.github/agents/hve-core/subagents/plan-validator.agent.md.github/agents/hve-core/subagents/prompt-evaluator.agent.md.github/agents/hve-core/subagents/prompt-tester.agent.md.github/agents/hve-core/subagents/prompt-updater.agent.md.github/agents/hve-core/subagents/rpi-validator.agent.md.github/agents/hve-core/subagents/researcher-subagent.agent.mdEach section restates the plain-text path rule, provides two plain-text examples specific to the subagent's output artifact type, and notes that external URLs may still use markdown syntax.
Removed backticks from inline code examples in response-format pointer lines (e.g., "Re-read " instead of "Re-read
<path>") to align with the plain-text convention when those pointers are emitted into artifact files.Authoring Standard Update (1 file)
Updated
.github/instructions/hve-core/prompt-builder.instructions.mdto document the two-surface pattern explicitly:## File Reference Formattingtemplate row inside the Subagent Structural Template code block### Surface A: Artifact Content Referencessubsection with the plain-text rule and examplesExtended the Subagent Structural Template prose to explain when subagents should include the new File Reference Formatting section (paralleling the existing Required Protocol include/omit guidance).
Related Issue(s)
Closes #2018
Type of Change
.github/instructions/*.instructions.md).github/agents/*.agent.md)Testing
Automated validation commands run during the implementation phase:
npm run lint:md— Passed (236 files scanned, 0 errors)npm run lint:frontmatter— Passed (0 errors, 0 warnings)npm run lint:ai-artifacts— Passed (70 files scanned, 0 issues)No manual testing performed. All changes are documentation-only; no runtime or behavioral changes.
Checklist
Required Checks
AI Artifact Contributions
/prompt-analyzeto review contribution — Subagents and instructions reviewed via task planning workflowprompt-builderreview — Plan Validator findings resolved during planning phaseRequired Automated Checks
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run validate:skillsnpm run lint:md-linksnpm run lint:psnpm run plugin:generatenpm run docs:testSecurity Considerations