Skip to content

docs(#28): codify extension point annotation convention in skill resolution section - #30

Closed
fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/28-extension-point-docs
Closed

docs(#28): codify extension point annotation convention in skill resolution section#30
fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/28-extension-point-docs

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Add the inline YAML comment convention for extension point skills to AGENTS.md section 7 (Skill resolution). When a skill declared in agent frontmatter is intentionally absent from this repo and expected to be provided by target repos or org-level configuration, the reference should be annotated with an # extension point: comment. This makes the intent discoverable at the point of contact without requiring readers to consult the skill resolution docs.

The convention matches the existing annotation on the customer-research skill in agents/prioritize.md line 5 and prevents the false-positive review cycle seen in the PR #12 to #21 saga.


Closes #28

Post-script verification

  • Branch is not main/master (agent/28-extension-point-docs)
  • Secret scan passed (gitleaks — c362e3f6eeb2e78490e58745e4daf652f2abc402..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

…lution section

Add the inline YAML comment convention for extension point skills to
AGENTS.md section 7 (Skill resolution). When a skill declared in agent
frontmatter is intentionally absent from this repo and expected to be
provided by target repos or org-level configuration, the reference
should be annotated with an `# extension point:` comment. This makes
the intent discoverable at the point of contact without requiring
readers to consult the skill resolution docs.

The convention matches the existing annotation on the customer-research
skill in agents/prioritize.md line 5 and prevents the false-positive
review cycle seen in the PR #12 to #21 saga.

Closes #28
@ralphbean ralphbean closed this Jul 6, 2026
@ralphbean ralphbean reopened this Jul 6, 2026
@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Document extension-point skill annotation convention in AGENTS.md

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Define an inline # extension point: YAML comment for intentionally external skills.
• Add an example and rationale to prevent false-positive “missing skill” reviews.
High-Level Assessment

The inline YAML comment convention is the right approach: it places intent at the point of use (frontmatter) while keeping the broader resolution rules documented in AGENTS.md. Alternatives like relying solely on centralized documentation would be less discoverable and reintroduce review confusion.

Files changed (1) +11 / -0

Documentation (1) +11 / -0
AGENTS.mdCodify extension-point skill annotation convention +11/-0

Codify extension-point skill annotation convention

• Adds guidance to the Skill resolution section specifying that skills intentionally not present in this repo should be annotated with an inline '# extension point:' YAML comment. Includes a concrete example and explains the discoverability benefit for reviewers and agents.

AGENTS.md

@ralphbean

Copy link
Copy Markdown
Member

/fs-fix this feels like too much new context for AGENTS.md. Can this go somewhere deeper in the repo a la progressive context discovery?

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 📜 Skill insights (1)

Context used
✅ Compliance rules (platform): 55 rules
✅ Skills: 4 invoked
  code-review
  code-implementation
  pr-review
  docs-review

Grey Divider


Action required

1. AGENTS.md protected file modified 📜 Skill insight § Compliance
Description
This PR modifies AGENTS.md, which is a protected governance/infrastructure path and must not be
auto-approved. Ensure the change receives explicit human review/approval (e.g.,
CODEOWNERS/maintainers) even if the modification is documentation-only.
Code

AGENTS.md[R91-100]

+When declaring an extension point skill in agent frontmatter — a skill
+that is intentionally absent from this repo and expected to be provided
+by target repos or org-level configuration — annotate the reference with
+an inline YAML comment:
+
+    skills:
+      - customer-research  # extension point: provided by target repos
+
+This annotation gives agents and human readers immediate context at the
+point of contact, without needing to consult this section.
Evidence
The checklist requires raising a finding for any PR that modifies protected
governance/infrastructure paths, explicitly including AGENTS.md. The diff shows new content added
in AGENTS.md within the modified hunk.

AGENTS.md[91-100]
Skill: pr-review


Grey Divider

Qodo Logo

Comment thread AGENTS.md Outdated
Comment on lines +91 to +100
When declaring an extension point skill in agent frontmatter — a skill
that is intentionally absent from this repo and expected to be provided
by target repos or org-level configuration — annotate the reference with
an inline YAML comment:

skills:
- customer-research # extension point: provided by target repos

This annotation gives agents and human readers immediate context at the
point of contact, without needing to consult this section.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Action required

1. agents.md protected file modified 📜 Skill insight § Compliance

This PR modifies AGENTS.md, which is a protected governance/infrastructure path and must not be
auto-approved. Ensure the change receives explicit human review/approval (e.g.,
CODEOWNERS/maintainers) even if the modification is documentation-only.

@fullsend-ai-coder

fullsend-ai-coder Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Fix · ❌ Terminated · Started 7:02 PM UTC · Ended 7:09 PM UTC
Commit: e8381e3 · View workflow run →

@fullsend-ai-retro

fullsend-ai-retro Bot commented Jul 6, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 7:03 PM UTC · Completed 7:11 PM UTC
Commit: 9d6c1db · View workflow run →

Move extension point annotation guidance from AGENTS.md section 7 to
docs/skill-resolution.md for progressive context discovery. AGENTS.md
now contains a brief pointer to the deeper document.

Addresses review feedback on #30
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 7:02 PM UTC · Completed 7:09 PM UTC
Commit: e8381e3 · View workflow run →

@fullsend-ai-retro

Copy link
Copy Markdown

PR #30 adds 11 lines to AGENTS.md documenting the extension point annotation convention. The human maintainer (ralphbean) rejected the placement, commenting that it feels like too much new context for AGENTS.md and asking for progressive context discovery. This is the 5th retro-filed issue (#13, #17, #18, #20, #28) on the same topic (extension point skills) consuming significant agent compute over 4 days for what amounts to a 1-line YAML comment plus general docs. The code agent implemented the issue correctly; the problem is upstream in the retro agent's proposal, which prescribed AGENTS.md as the target without applying the progressive disclosure principle from its own loaded agent-scaffolding skill. Two proposals target the retro agent's decision-making in fullsend-ai/fullsend.

Proposals filed

@ralphbean

Copy link
Copy Markdown
Member

I'm just going to drop this. That docs/skill-resolution.md change looks so clunky.

@ralphbean ralphbean closed this Jul 6, 2026
@fullsend-ai-retro

fullsend-ai-retro Bot commented Jul 6, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 8:33 PM UTC · Completed 8:42 PM UTC
Commit: 09e6286 · View workflow run →

@fullsend-ai-retro

Copy link
Copy Markdown

PR #30 in fullsend-ai/agents was a docs-only PR adding the extension point annotation convention to AGENTS.md. The human maintainer (ralphbean) asked the fix agent to move the content to a deeper location via /fs-fix. The fix agent moved it to docs/skill-resolution.md, but the docs/ directory follows a per-agent documentation pattern (code.md, fix.md, prioritize.md, etc.), so adding a cross-cutting reference doc there was organizationally wrong. The human found the result "clunky" and closed the PR without merging. Issue #28 remains open despite the rejection. This is the second retro on PR #30 — the first retro (run 28816061106) already filed excellent proposals in fullsend-ai/fullsend#3168 (progressive disclosure for context files) and #3169 (topic chain detection). This second retro is itself evidence for fullsend-ai/fullsend#2401 (dedup retro runs on same PR). The orphaned issue #28 is evidence for fullsend-ai/fullsend#3050 (remove ready-to-code from linked issues when PR is rejected). One novel finding: the fix agent should analyze existing directory structure before creating new files.

Proposals filed

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.

docs: codify extension point annotation convention in AGENTS.md section 6

1 participant