Skip to content

AGENTS.md

Latest commit

 

History

History
58 lines (43 loc) · 2.31 KB

AGENTS.md

File metadata and controls

58 lines (43 loc) · 2.31 KB

Agent Instructions

This repository distributes the compound-engineering plugin from a portable source of truth, then generates platform-specific outputs for Claude Code and Copilot.

Working Agreement

  • Branching: Create a feature branch for any non-trivial change. If already on the correct branch for the task, keep using it; do not create additional branches or worktrees unless explicitly requested.
  • Safety: Do not delete or overwrite user data. Avoid destructive commands.
  • ASCII-first: Use ASCII unless the file already contains Unicode.

Repository Structure

compound-engineering-plugin/
├── portable/compound-engineering/    # Canonical portable source
├── .claude-plugin/marketplace.json   # Generated Claude marketplace catalog
├── .github/                          # Generated Copilot assets
├── plugins/compound-engineering/     # Generated Claude plugin
│   ├── .claude-plugin/plugin.json
│   ├── agents/                       # Specialized AI agents
│   ├── commands/                     # Slash commands
│   ├── skills/                       # Skills
│   ├── hooks/                        # Hooks
│   └── mcp-servers/                  # MCP servers
└── docs/                             # Documentation site

Component Update Checklist

When adding/removing agents, commands, or skills:

  1. Edit portable/compound-engineering/ first
  2. Rebuild generated outputs with bun run build:platforms
  3. Update plugins/compound-engineering/README.md -- component tables
  4. Update plugins/compound-engineering/CHANGELOG.md -- document changes
  5. Validate JSON: cat .claude-plugin/marketplace.json | jq .

Portable Build Workflow

Use the portable source as the only hand-edited definition:

bun run build:platforms

This regenerates:

  • plugins/compound-engineering/ for Claude Code
  • .github/ for Copilot

Docs Directory Convention

All workflows write output to {project_root}/docs/:

  • docs/ideation/ -- ideation artifacts (generated by /workflows:ideate)
  • docs/plans/ -- implementation plans
  • docs/brainstorms/ -- brainstorm documents
  • docs/solutions/ -- compounded learnings (DO NOT gitignore)
  • docs/execution-sessions/ -- work session logs (local workflow artifacts; ignore them in this repo)