Skip to content

Add AGENTS.md (CLAUDE.md symlink) and build / plugin-e2e skills (.agents/skills symlink) - #261

Merged
mrproliu merged 1 commit into
mainfrom
docs/agents-md-and-skills
Oct 18, 2026
Merged

mrproliu merged 1 commit into
mainfrom
docs/agents-md-and-skills

Conversation

@wu-sheng

@wu-sheng wu-sheng commented Oct 18, 2026 •

Copy link
Copy Markdown
Member

Adds guidance for coding agents, based on what PR #260 (the Go 1.26 floor and plugin range refresh) needed to get right.

What's added

  • AGENTS.md covers:
    • the repository layout and the hybrid-compilation model, and the Go version policy;
    • build, test, and lint commands;
    • the rules that follow from how the agent rewrites plugin code: first-match instrument selection, copied files that can only use the hooked package's direct imports, native mirrors, receiver-only hook matching, and version-split plugin folders;
    • the plugin test harness semantics (GOWORK=off, exact framework: module paths, excepted-file, toolkit);
    • the changelog, docs, and CI conventions (the ASF actions allow-list);
    • known pitfalls: the stale VERSION file, and build-cache pollution from -toolexec builds.
  • CLAUDE.md is a symlink to AGENTS.md, so both stay identical.
  • .claude/skills/build builds the agent, runs tests and lint (golangci-lint v2.15.0), checks the Go 1.26 floor, and compiles an instrumented application to verify copied plugin code at both ends of a version range.
  • .claude/skills/plugin-e2e runs plugin scenarios and the e2e suite locally the way CI does, narrows a run to some versions, and maps common build, dependency, runtime, and validation failures to their causes.
  • .agents/skills is a symlink to .claude/skills, so other agents also discover the same skills. Verified with the Codex CLI: it lists build and plugin-e2e with the symlink and none without it.
  • .gitignore ignores .claude/worktrees/ and .claude/settings.local.json.

Markdown is excluded from the license header check, so none of the new files need a header. The license-eye version pinned in CI (apache/skywalking-eyes@9bd5feb) recurses forever on directory symlinks, so .licenserc.yaml ignores .agents/skills. Without that, the check fails with fatal error: stack overflow. This was reproduced with that exact license-eye build, and the check passes with the ignore entry.

Review

Four rounds of read-only review by an external model checked the links, every factual statement in AGENTS.md against the source, and every skill command. Each finding was fixed, and the final round confirmed it with no remaining findings.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Ej1HubxqebgChKygA5TTHP

@wu-sheng
wu-sheng force-pushed the docs/agents-md-and-skills branch from 837c975 to b1d672e Compare October 18, 2026 09:03
@wu-sheng wu-sheng changed the title Add AGENTS.md (CLAUDE.md symlink) and build / plugin-e2e skills Add AGENTS.md (CLAUDE.md symlink) and build / plugin-e2e skills (.agents/skills symlink) Oct 18, 2026
@wu-sheng wu-sheng added this to the 0.8.0 milestone Oct 18, 2026
@wu-sheng wu-sheng added the chore label Oct 18, 2026
…kills

AGENTS.md is the guide for coding agents: the repository layout, the Go
version policy, how to build, test, and lint, the rules that follow from
how the agent copies and rewrites plugin code (instrument selection, the
direct-import rule for copied files, native mirrors, receiver-only
matching, version-split plugins), the plugin test harness semantics, and
the changelog, docs, and CI conventions. CLAUDE.md is a symlink to it.

The build skill builds the agent, runs tests and lint, checks the Go 1.26
floor, and compiles an instrumented application to verify copied plugin
code at both ends of a version range. The plugin-e2e skill runs plugin
scenarios and the e2e suite locally and maps common failures to causes.

Claude worktrees and local settings are ignored.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Ej1HubxqebgChKygA5TTHP
@wu-sheng
wu-sheng force-pushed the docs/agents-md-and-skills branch from b1d672e to ee72dde Compare October 18, 2026 09:50
@wu-sheng
wu-sheng requested a review from mrproliu October 18, 2026 10:25
@mrproliu
mrproliu merged commit 7efac2c into main Oct 18, 2026
49 checks passed
@mrproliu
mrproliu deleted the docs/agents-md-and-skills branch October 18, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants