nitm-ai-dev-toolkit 3.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +109 -0
- package/LICENSE +21 -0
- package/README.md +881 -0
- package/bin/cli.js +398 -0
- package/package.json +41 -0
- package/src/monorepo/.agents/rules/ponytail.md +3 -0
- package/src/monorepo/.agents/skills/acli/SKILL.md +424 -0
- package/src/monorepo/.agents/skills/bkt-cli/SKILL.md +374 -0
- package/src/monorepo/.agents/skills/brainstorming/SKILL.md +54 -0
- package/src/monorepo/.agents/skills/code-simplifier/SKILL.md +109 -0
- package/src/monorepo/.agents/skills/debugger/SKILL.md +123 -0
- package/src/monorepo/.agents/skills/dispatching-parallel-agents/SKILL.md +206 -0
- package/src/monorepo/.agents/skills/executing-plans/SKILL.md +76 -0
- package/src/monorepo/.agents/skills/finishing-a-development-branch/SKILL.md +200 -0
- package/src/monorepo/.agents/skills/gh-cli/SKILL.md +461 -0
- package/src/monorepo/.agents/skills/glab-cli/SKILL.md +468 -0
- package/src/monorepo/.agents/skills/issue-tracker/SKILL.md +119 -0
- package/src/monorepo/.agents/skills/linear-cli/SKILL.md +276 -0
- package/src/monorepo/.agents/skills/logging/SKILL.md +393 -0
- package/src/monorepo/.agents/skills/orient-to-recent-work/SKILL.md +43 -0
- package/src/monorepo/.agents/skills/ponytail/SKILL.md +101 -0
- package/src/monorepo/.agents/skills/ponytail-audit/SKILL.md +41 -0
- package/src/monorepo/.agents/skills/ponytail-debt/SKILL.md +44 -0
- package/src/monorepo/.agents/skills/ponytail-gain/SKILL.md +51 -0
- package/src/monorepo/.agents/skills/ponytail-help/SKILL.md +74 -0
- package/src/monorepo/.agents/skills/ponytail-review/SKILL.md +57 -0
- package/src/monorepo/.agents/skills/project-documentation/SKILL.md +425 -0
- package/src/monorepo/.agents/skills/receiving-code-review/SKILL.md +213 -0
- package/src/monorepo/.agents/skills/requesting-code-review/SKILL.md +105 -0
- package/src/monorepo/.agents/skills/requesting-code-review/code-reviewer.md +146 -0
- package/src/monorepo/.agents/skills/security-reviewer/SKILL.md +144 -0
- package/src/monorepo/.agents/skills/subagent-driven-development/SKILL.md +279 -0
- package/src/monorepo/.agents/skills/subagent-driven-development/code-quality-reviewer-prompt.md +20 -0
- package/src/monorepo/.agents/skills/subagent-driven-development/implementer-prompt.md +78 -0
- package/src/monorepo/.agents/skills/subagent-driven-development/spec-reviewer-prompt.md +61 -0
- package/src/monorepo/.agents/skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/src/monorepo/.agents/skills/systematic-debugging/SKILL.md +296 -0
- package/src/monorepo/.agents/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/src/monorepo/.agents/skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/src/monorepo/.agents/skills/systematic-debugging/defense-in-depth.md +122 -0
- package/src/monorepo/.agents/skills/systematic-debugging/find-polluter.sh +63 -0
- package/src/monorepo/.agents/skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/src/monorepo/.agents/skills/systematic-debugging/test-academic.md +14 -0
- package/src/monorepo/.agents/skills/systematic-debugging/test-pressure-1.md +58 -0
- package/src/monorepo/.agents/skills/systematic-debugging/test-pressure-2.md +68 -0
- package/src/monorepo/.agents/skills/systematic-debugging/test-pressure-3.md +69 -0
- package/src/monorepo/.agents/skills/test-driven-development/SKILL.md +371 -0
- package/src/monorepo/.agents/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/src/monorepo/.agents/skills/using-git-worktrees/SKILL.md +291 -0
- package/src/monorepo/.agents/skills/using-superpowers/SKILL.md +87 -0
- package/src/monorepo/.agents/skills/verification-before-completion/SKILL.md +148 -0
- package/src/monorepo/.agents/skills/writing-plans/SKILL.md +116 -0
- package/src/monorepo/.agents/skills/writing-skills/SKILL.md +655 -0
- package/src/monorepo/.agents/skills/writing-skills/anthropic-best-practices.md +1150 -0
- package/src/monorepo/.agents/skills/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
- package/src/monorepo/.agents/skills/writing-skills/graphviz-conventions.dot +172 -0
- package/src/monorepo/.agents/skills/writing-skills/persuasion-principles.md +187 -0
- package/src/monorepo/.agents/skills/writing-skills/render-graphs.js +168 -0
- package/src/monorepo/.agents/skills/writing-skills/testing-skills-with-subagents.md +384 -0
- package/src/monorepo/.claude/agents/admin-portal.agent.md +11 -0
- package/src/monorepo/.claude/agents/api-specialist.agent.md +11 -0
- package/src/monorepo/.claude/agents/backend-architect.agent.md +11 -0
- package/src/monorepo/.claude/agents/documenter.agent.md +11 -0
- package/src/monorepo/.claude/agents/feature-builder.agent.md +23 -0
- package/src/monorepo/.claude/agents/frontend-developer.agent.md +11 -0
- package/src/monorepo/.claude/agents/green.agent.md +12 -0
- package/src/monorepo/.claude/agents/implementer.agent.md +12 -0
- package/src/monorepo/.claude/agents/planner.agent.md +12 -0
- package/src/monorepo/.claude/agents/red.agent.md +12 -0
- package/src/monorepo/.claude/agents/refactor.agent.md +12 -0
- package/src/monorepo/.claude/agents/researcher.agent.md +12 -0
- package/src/monorepo/.claude/agents/reviewer.agent.md +11 -0
- package/src/monorepo/.claude/agents/tdd.agent.md +12 -0
- package/src/monorepo/.claude/agents-snippets/admin-portal.md +90 -0
- package/src/monorepo/.claude/agents-snippets/api-specialist.md +57 -0
- package/src/monorepo/.claude/agents-snippets/backend-architect.md +49 -0
- package/src/monorepo/.claude/agents-snippets/documenter.md +58 -0
- package/src/monorepo/.claude/agents-snippets/feature-builder.md +49 -0
- package/src/monorepo/.claude/agents-snippets/frontend-developer.md +49 -0
- package/src/monorepo/.claude/agents-snippets/green.md +18 -0
- package/src/monorepo/.claude/agents-snippets/implementer.md +31 -0
- package/src/monorepo/.claude/agents-snippets/planner.md +40 -0
- package/src/monorepo/.claude/agents-snippets/red.md +14 -0
- package/src/monorepo/.claude/agents-snippets/refactor.md +22 -0
- package/src/monorepo/.claude/agents-snippets/researcher.md +43 -0
- package/src/monorepo/.claude/agents-snippets/reviewer.md +83 -0
- package/src/monorepo/.claude/agents-snippets/tdd.md +18 -0
- package/src/monorepo/.claude/commands/assign-tasks.md +13 -0
- package/src/monorepo/.claude/commands/bootstrap-patch.md +15 -0
- package/src/monorepo/.claude/commands/bootstrap-upgrade.md +15 -0
- package/src/monorepo/.claude/commands/bootstrap.md +15 -0
- package/src/monorepo/.claude/commands/commit-push.md +13 -0
- package/src/monorepo/.claude/commands/constitution.md +15 -0
- package/src/monorepo/.claude/commands/create-skill.md +15 -0
- package/src/monorepo/.claude/commands/implement-feature.md +15 -0
- package/src/monorepo/.claude/commands/implement-fixes.md +15 -0
- package/src/monorepo/.claude/commands/implement.md +15 -0
- package/src/monorepo/.claude/commands/plan.md +15 -0
- package/src/monorepo/.claude/commands/playwright-test.md +13 -0
- package/src/monorepo/.claude/commands/ponytail-audit.md +15 -0
- package/src/monorepo/.claude/commands/ponytail-debt.md +15 -0
- package/src/monorepo/.claude/commands/ponytail-gain.md +15 -0
- package/src/monorepo/.claude/commands/ponytail-help.md +15 -0
- package/src/monorepo/.claude/commands/ponytail-review.md +15 -0
- package/src/monorepo/.claude/commands/ponytail.md +15 -0
- package/src/monorepo/.claude/commands/release-notes.md +13 -0
- package/src/monorepo/.claude/commands/review-pr.md +15 -0
- package/src/monorepo/.claude/commands/review-staged.md +15 -0
- package/src/monorepo/.claude/commands/review.md +15 -0
- package/src/monorepo/.claude/commands/specify.md +15 -0
- package/src/monorepo/.claude/commands/tasks.md +13 -0
- package/src/monorepo/.claude/prompt-snippets/assign-tasks.md +169 -0
- package/src/monorepo/.claude/prompt-snippets/bootstrap-patch.md +199 -0
- package/src/monorepo/.claude/prompt-snippets/bootstrap-upgrade.md +452 -0
- package/src/monorepo/.claude/prompt-snippets/bootstrap.md +764 -0
- package/src/monorepo/.claude/prompt-snippets/commit-push.md +69 -0
- package/src/monorepo/.claude/prompt-snippets/constitution.md +57 -0
- package/src/monorepo/.claude/prompt-snippets/create-skill.md +490 -0
- package/src/monorepo/.claude/prompt-snippets/implement-feature.md +119 -0
- package/src/monorepo/.claude/prompt-snippets/implement-fixes.md +122 -0
- package/src/monorepo/.claude/prompt-snippets/implement.md +56 -0
- package/src/monorepo/.claude/prompt-snippets/plan.md +67 -0
- package/src/monorepo/.claude/prompt-snippets/playwright-test.md +55 -0
- package/src/monorepo/.claude/prompt-snippets/ponytail-audit.md +5 -0
- package/src/monorepo/.claude/prompt-snippets/ponytail-debt.md +5 -0
- package/src/monorepo/.claude/prompt-snippets/ponytail-gain.md +5 -0
- package/src/monorepo/.claude/prompt-snippets/ponytail-help.md +5 -0
- package/src/monorepo/.claude/prompt-snippets/ponytail-review.md +5 -0
- package/src/monorepo/.claude/prompt-snippets/ponytail.md +5 -0
- package/src/monorepo/.claude/prompt-snippets/release-notes.md +134 -0
- package/src/monorepo/.claude/prompt-snippets/review-pr.md +156 -0
- package/src/monorepo/.claude/prompt-snippets/review-staged.md +35 -0
- package/src/monorepo/.claude/prompt-snippets/review.md +139 -0
- package/src/monorepo/.claude/prompt-snippets/specify.md +51 -0
- package/src/monorepo/.claude/prompt-snippets/tasks.md +108 -0
- package/src/monorepo/.claude/rules/agent-conduct.md +14 -0
- package/src/monorepo/.claude/rules/api-server.md +19 -0
- package/src/monorepo/.claude/rules/coding-standards.md +13 -0
- package/src/monorepo/.claude/rules/component-structure.md +18 -0
- package/src/monorepo/.claude/rules/core-libraries.md +16 -0
- package/src/monorepo/.claude/rules/environment-tooling.md +12 -0
- package/src/monorepo/.claude/rules/logging-comments.md +17 -0
- package/src/monorepo/.claude/rules/logging.md +17 -0
- package/src/monorepo/.claude/rules/orient-to-recent-work.md +13 -0
- package/src/monorepo/.claude/rules/prisma-migrations.md +16 -0
- package/src/monorepo/.claude/rules/project-context.md +14 -0
- package/src/monorepo/.claude/rules/server-client-separation.md +17 -0
- package/src/monorepo/.claude/rules/subagent-workflow.md +14 -0
- package/src/monorepo/.claude/rules/testing-quality.md +19 -0
- package/src/monorepo/.claude/rules/testing.md +16 -0
- package/src/monorepo/.claude/rules/ui-accessibility.md +18 -0
- package/src/monorepo/.claude/rules/version-control.md +14 -0
- package/src/monorepo/.claude/rules/what-to-avoid.md +14 -0
- package/src/monorepo/.claude/rules-snippets/agent-conduct.md +51 -0
- package/src/monorepo/.claude/rules-snippets/api-server.md +5 -0
- package/src/monorepo/.claude/rules-snippets/coding-standards.md +45 -0
- package/src/monorepo/.claude/rules-snippets/component-structure.md +6 -0
- package/src/monorepo/.claude/rules-snippets/core-libraries.md +6 -0
- package/src/monorepo/.claude/rules-snippets/deployment.md +41 -0
- package/src/monorepo/.claude/rules-snippets/documentation.md +210 -0
- package/src/monorepo/.claude/rules-snippets/environment-tooling.md +4 -0
- package/src/monorepo/.claude/rules-snippets/logging-comments.md +4 -0
- package/src/monorepo/.claude/rules-snippets/logging.md +107 -0
- package/src/monorepo/.claude/rules-snippets/patterns.md +134 -0
- package/src/monorepo/.claude/rules-snippets/ponytail.md +24 -0
- package/src/monorepo/.claude/rules-snippets/prisma-migrations.md +6 -0
- package/src/monorepo/.claude/rules-snippets/project-context.md +8 -0
- package/src/monorepo/.claude/rules-snippets/server-client-separation.md +5 -0
- package/src/monorepo/.claude/rules-snippets/subagent-workflow.md +134 -0
- package/src/monorepo/.claude/rules-snippets/testing-quality.md +5 -0
- package/src/monorepo/.claude/rules-snippets/testing.md +42 -0
- package/src/monorepo/.claude/rules-snippets/ui-accessibility.md +5 -0
- package/src/monorepo/.claude/rules-snippets/version-control.md +4 -0
- package/src/monorepo/.claude/rules-snippets/what-to-avoid.md +6 -0
- package/src/monorepo/.claude/rules-snippets/workflows.md +81 -0
- package/src/monorepo/.claude/settings.json +7 -0
- package/src/monorepo/.claude/skills/README.md +50 -0
- package/src/monorepo/.cursor/agents/admin-portal.agent.md +11 -0
- package/src/monorepo/.cursor/agents/api-specialist.agent.md +11 -0
- package/src/monorepo/.cursor/agents/backend-architect.agent.md +11 -0
- package/src/monorepo/.cursor/agents/documenter.agent.md +11 -0
- package/src/monorepo/.cursor/agents/feature-builder.agent.md +11 -0
- package/src/monorepo/.cursor/agents/frontend-developer.agent.md +11 -0
- package/src/monorepo/.cursor/agents/green.agent.md +11 -0
- package/src/monorepo/.cursor/agents/implementer.agent.md +11 -0
- package/src/monorepo/.cursor/agents/planner.agent.md +11 -0
- package/src/monorepo/.cursor/agents/red.agent.md +11 -0
- package/src/monorepo/.cursor/agents/refactor.agent.md +11 -0
- package/src/monorepo/.cursor/agents/researcher.agent.md +11 -0
- package/src/monorepo/.cursor/agents/reviewer.agent.md +11 -0
- package/src/monorepo/.cursor/agents/tdd.agent.md +11 -0
- package/src/monorepo/.cursor/commands/assign-tasks.md +13 -0
- package/src/monorepo/.cursor/commands/bootstrap-patch.md +17 -0
- package/src/monorepo/.cursor/commands/bootstrap-upgrade.md +15 -0
- package/src/monorepo/.cursor/commands/bootstrap.md +17 -0
- package/src/monorepo/.cursor/commands/commit-push.md +15 -0
- package/src/monorepo/.cursor/commands/constitution.md +17 -0
- package/src/monorepo/.cursor/commands/create-skill.md +17 -0
- package/src/monorepo/.cursor/commands/implement-feature.md +17 -0
- package/src/monorepo/.cursor/commands/implement-fixes.md +17 -0
- package/src/monorepo/.cursor/commands/implement.md +17 -0
- package/src/monorepo/.cursor/commands/plan.md +17 -0
- package/src/monorepo/.cursor/commands/playwright-test.md +15 -0
- package/src/monorepo/.cursor/commands/ponytail-audit.md +13 -0
- package/src/monorepo/.cursor/commands/ponytail-debt.md +13 -0
- package/src/monorepo/.cursor/commands/ponytail-gain.md +13 -0
- package/src/monorepo/.cursor/commands/ponytail-help.md +13 -0
- package/src/monorepo/.cursor/commands/ponytail-review.md +13 -0
- package/src/monorepo/.cursor/commands/ponytail.md +13 -0
- package/src/monorepo/.cursor/commands/release-notes.md +15 -0
- package/src/monorepo/.cursor/commands/review-pr.md +17 -0
- package/src/monorepo/.cursor/commands/review-staged.md +10 -0
- package/src/monorepo/.cursor/commands/review.md +17 -0
- package/src/monorepo/.cursor/commands/specify.md +17 -0
- package/src/monorepo/.cursor/commands/tasks.md +15 -0
- package/src/monorepo/.cursor/mcp.json +13 -0
- package/src/monorepo/.cursor/rules/agent-conduct.mdc +11 -0
- package/src/monorepo/.cursor/rules/api-server.mdc +11 -0
- package/src/monorepo/.cursor/rules/coding-standards.mdc +11 -0
- package/src/monorepo/.cursor/rules/component-structure.mdc +11 -0
- package/src/monorepo/.cursor/rules/core-libraries.mdc +11 -0
- package/src/monorepo/.cursor/rules/environment-tooling.mdc +11 -0
- package/src/monorepo/.cursor/rules/logging-comments.mdc +11 -0
- package/src/monorepo/.cursor/rules/logging.mdc +10 -0
- package/src/monorepo/.cursor/rules/orient-to-recent-work.mdc +9 -0
- package/src/monorepo/.cursor/rules/ponytail.mdc +9 -0
- package/src/monorepo/.cursor/rules/prisma-migrations.mdc +11 -0
- package/src/monorepo/.cursor/rules/project-context.mdc +11 -0
- package/src/monorepo/.cursor/rules/server-client-separation.mdc +11 -0
- package/src/monorepo/.cursor/rules/subagent-workflow.mdc +11 -0
- package/src/monorepo/.cursor/rules/testing-quality.mdc +11 -0
- package/src/monorepo/.cursor/rules/ui-accessibility.mdc +11 -0
- package/src/monorepo/.cursor/rules/version-control.mdc +11 -0
- package/src/monorepo/.cursor/rules/what-to-avoid.mdc +11 -0
- package/src/monorepo/.cursor/skills/README.md +50 -0
- package/src/monorepo/.github/agents/admin-portal.agent.md +11 -0
- package/src/monorepo/.github/agents/api-specialist.agent.md +11 -0
- package/src/monorepo/.github/agents/backend-architect.agent.md +11 -0
- package/src/monorepo/.github/agents/documenter.agent.md +11 -0
- package/src/monorepo/.github/agents/feature-builder.agent.md +24 -0
- package/src/monorepo/.github/agents/frontend-developer.agent.md +11 -0
- package/src/monorepo/.github/agents/green.agent.md +12 -0
- package/src/monorepo/.github/agents/implementer.agent.md +12 -0
- package/src/monorepo/.github/agents/planner.agent.md +12 -0
- package/src/monorepo/.github/agents/red.agent.md +12 -0
- package/src/monorepo/.github/agents/refactor.agent.md +12 -0
- package/src/monorepo/.github/agents/researcher.agent.md +12 -0
- package/src/monorepo/.github/agents/reviewer.agent.md +11 -0
- package/src/monorepo/.github/agents/tdd.agent.md +13 -0
- package/src/monorepo/.github/copilot-instructions.md +95 -0
- package/src/monorepo/.github/instructions/agent-conduct.instructions.md +14 -0
- package/src/monorepo/.github/instructions/api-server.instructions.md +14 -0
- package/src/monorepo/.github/instructions/coding-standards.instructions.md +13 -0
- package/src/monorepo/.github/instructions/component-structure.instructions.md +14 -0
- package/src/monorepo/.github/instructions/core-libraries.instructions.md +14 -0
- package/src/monorepo/.github/instructions/deployment.instructions.md +13 -0
- package/src/monorepo/.github/instructions/documentation.instructions.md +14 -0
- package/src/monorepo/.github/instructions/environment-tooling.instructions.md +14 -0
- package/src/monorepo/.github/instructions/logging-comments.instructions.md +14 -0
- package/src/monorepo/.github/instructions/logging.instructions.md +14 -0
- package/src/monorepo/.github/instructions/patterns.instructions.md +14 -0
- package/src/monorepo/.github/instructions/prisma-migrations.instructions.md +14 -0
- package/src/monorepo/.github/instructions/project-context.instructions.md +13 -0
- package/src/monorepo/.github/instructions/server-client-separation.instructions.md +14 -0
- package/src/monorepo/.github/instructions/subagent-workflow.instructions.md +14 -0
- package/src/monorepo/.github/instructions/testing-quality.instructions.md +15 -0
- package/src/monorepo/.github/instructions/testing.instructions.md +14 -0
- package/src/monorepo/.github/instructions/ui-accessibility.instructions.md +14 -0
- package/src/monorepo/.github/instructions/version-control.instructions.md +14 -0
- package/src/monorepo/.github/instructions/what-to-avoid.instructions.md +14 -0
- package/src/monorepo/.github/instructions/workflows.instructions.md +14 -0
- package/src/monorepo/.github/prompts/assign-tasks.prompt.md +14 -0
- package/src/monorepo/.github/prompts/bootstrap-patch.prompt.md +15 -0
- package/src/monorepo/.github/prompts/bootstrap-upgrade.prompt.md +15 -0
- package/src/monorepo/.github/prompts/bootstrap.prompt.md +15 -0
- package/src/monorepo/.github/prompts/commit-push.prompt.md +13 -0
- package/src/monorepo/.github/prompts/constitution.prompt.md +15 -0
- package/src/monorepo/.github/prompts/create-skill.prompt.md +15 -0
- package/src/monorepo/.github/prompts/implement-feature.prompt.md +15 -0
- package/src/monorepo/.github/prompts/implement-fixes.prompt.md +15 -0
- package/src/monorepo/.github/prompts/implement.prompt.md +15 -0
- package/src/monorepo/.github/prompts/plan.prompt.md +15 -0
- package/src/monorepo/.github/prompts/playwright-test.prompt.md +13 -0
- package/src/monorepo/.github/prompts/ponytail-audit.prompt.md +13 -0
- package/src/monorepo/.github/prompts/ponytail-debt.prompt.md +13 -0
- package/src/monorepo/.github/prompts/ponytail-gain.prompt.md +13 -0
- package/src/monorepo/.github/prompts/ponytail-help.prompt.md +13 -0
- package/src/monorepo/.github/prompts/ponytail-review.prompt.md +13 -0
- package/src/monorepo/.github/prompts/ponytail.prompt.md +13 -0
- package/src/monorepo/.github/prompts/release-notes.prompt.md +13 -0
- package/src/monorepo/.github/prompts/review-pr.prompt.md +15 -0
- package/src/monorepo/.github/prompts/review-staged.prompt.md +16 -0
- package/src/monorepo/.github/prompts/review.prompt.md +15 -0
- package/src/monorepo/.github/prompts/specify.prompt.md +15 -0
- package/src/monorepo/.github/prompts/tasks.prompt.md +13 -0
- package/src/monorepo/.github/skills/README.md +36 -0
- package/src/monorepo/.mcp.json +13 -0
- package/src/monorepo/.opencode/agents/admin-portal.md +14 -0
- package/src/monorepo/.opencode/agents/api-specialist.md +14 -0
- package/src/monorepo/.opencode/agents/backend-architect.md +14 -0
- package/src/monorepo/.opencode/agents/documenter.md +14 -0
- package/src/monorepo/.opencode/agents/feature-builder.md +15 -0
- package/src/monorepo/.opencode/agents/frontend-developer.md +14 -0
- package/src/monorepo/.opencode/agents/green.md +14 -0
- package/src/monorepo/.opencode/agents/implementer.md +14 -0
- package/src/monorepo/.opencode/agents/planner.md +14 -0
- package/src/monorepo/.opencode/agents/red.md +14 -0
- package/src/monorepo/.opencode/agents/refactor.md +14 -0
- package/src/monorepo/.opencode/agents/researcher.md +14 -0
- package/src/monorepo/.opencode/agents/reviewer.md +14 -0
- package/src/monorepo/.opencode/agents/tdd.md +15 -0
- package/src/monorepo/.opencode/commands/assign-tasks.md +16 -0
- package/src/monorepo/.opencode/commands/bootstrap-patch.md +18 -0
- package/src/monorepo/.opencode/commands/bootstrap-upgrade.md +18 -0
- package/src/monorepo/.opencode/commands/bootstrap.md +18 -0
- package/src/monorepo/.opencode/commands/commit-push.md +16 -0
- package/src/monorepo/.opencode/commands/constitution.md +18 -0
- package/src/monorepo/.opencode/commands/create-skill.md +16 -0
- package/src/monorepo/.opencode/commands/implement-feature.md +18 -0
- package/src/monorepo/.opencode/commands/implement-fixes.md +20 -0
- package/src/monorepo/.opencode/commands/implement.md +18 -0
- package/src/monorepo/.opencode/commands/plan.md +18 -0
- package/src/monorepo/.opencode/commands/playwright-test.md +16 -0
- package/src/monorepo/.opencode/commands/ponytail-audit.md +10 -0
- package/src/monorepo/.opencode/commands/ponytail-debt.md +10 -0
- package/src/monorepo/.opencode/commands/ponytail-gain.md +10 -0
- package/src/monorepo/.opencode/commands/ponytail-help.md +10 -0
- package/src/monorepo/.opencode/commands/ponytail-review.md +10 -0
- package/src/monorepo/.opencode/commands/ponytail.md +10 -0
- package/src/monorepo/.opencode/commands/release-notes.md +16 -0
- package/src/monorepo/.opencode/commands/review-pr.md +18 -0
- package/src/monorepo/.opencode/commands/review-staged.md +11 -0
- package/src/monorepo/.opencode/commands/review.md +18 -0
- package/src/monorepo/.opencode/commands/specify.md +18 -0
- package/src/monorepo/.opencode/commands/tasks.md +16 -0
- package/src/monorepo/.opencode/opencode.json +9 -0
- package/src/monorepo/.opencode/plugins/ponytail.mjs +79 -0
- package/src/monorepo/.opencode/rules/agent-conduct.md +12 -0
- package/src/monorepo/.opencode/rules/api-server.md +11 -0
- package/src/monorepo/.opencode/rules/coding-standards.md +11 -0
- package/src/monorepo/.opencode/rules/component-structure.md +11 -0
- package/src/monorepo/.opencode/rules/core-libraries.md +11 -0
- package/src/monorepo/.opencode/rules/environment-tooling.md +11 -0
- package/src/monorepo/.opencode/rules/logging-comments.md +11 -0
- package/src/monorepo/.opencode/rules/logging.md +11 -0
- package/src/monorepo/.opencode/rules/ponytail.md +3 -0
- package/src/monorepo/.opencode/rules/prisma-migrations.md +11 -0
- package/src/monorepo/.opencode/rules/project-context.md +11 -0
- package/src/monorepo/.opencode/rules/server-client-separation.md +11 -0
- package/src/monorepo/.opencode/rules/subagent-workflow.md +11 -0
- package/src/monorepo/.opencode/rules/testing-quality.md +11 -0
- package/src/monorepo/.opencode/rules/ui-accessibility.md +11 -0
- package/src/monorepo/.opencode/rules/version-control.md +11 -0
- package/src/monorepo/.opencode/rules/what-to-avoid.md +11 -0
- package/src/monorepo/.vscode/mcp.json +13 -0
- package/src/monorepo/AGENTS.md +367 -0
- package/src/monorepo/CLAUDE.md +63 -0
- package/src/monorepo/README.md +182 -0
- package/src/monorepo/apps/app-template/AGENTS.md +169 -0
- package/src/monorepo/apps/app-template/README.md +77 -0
- package/src/monorepo/docs/api/README.md +82 -0
- package/src/monorepo/docs/architecture/README.md +56 -0
- package/src/monorepo/docs/features/README.md +82 -0
- package/src/monorepo/docs/fixes/README.md +117 -0
- package/src/monorepo/hooks/claude-codex-hooks.json +31 -0
- package/src/monorepo/hooks/copilot-hooks.json +21 -0
- package/src/monorepo/hooks/ponytail-activate.js +91 -0
- package/src/monorepo/hooks/ponytail-config.js +122 -0
- package/src/monorepo/hooks/ponytail-instructions.js +92 -0
- package/src/monorepo/hooks/ponytail-mode-tracker.js +55 -0
- package/src/monorepo/hooks/ponytail-runtime.js +51 -0
- package/src/monorepo/hooks/ponytail-statusline.ps1 +21 -0
- package/src/monorepo/hooks/ponytail-statusline.sh +12 -0
- package/src/monorepo/packages/package-template/README.md +63 -0
- package/src/monorepo/templates/README.md +106 -0
- package/src/monorepo/templates/adr.template.md +156 -0
- package/src/monorepo/templates/complex-fix-plan.template.md +154 -0
- package/src/monorepo/templates/complex-fix-spec.template.md +160 -0
- package/src/monorepo/templates/feature-plan.template.md +192 -0
- package/src/monorepo/templates/feature-spec.template.md +148 -0
- package/src/monorepo/templates/monthly-fix-log.template.md +92 -0
- package/src/repo/.agents/rules/ponytail.md +3 -0
- package/src/repo/.agents/skills/acli/SKILL.md +424 -0
- package/src/repo/.agents/skills/bkt-cli/SKILL.md +374 -0
- package/src/repo/.agents/skills/brainstorming/SKILL.md +54 -0
- package/src/repo/.agents/skills/code-simplifier/SKILL.md +109 -0
- package/src/repo/.agents/skills/debugger/SKILL.md +123 -0
- package/src/repo/.agents/skills/dispatching-parallel-agents/SKILL.md +206 -0
- package/src/repo/.agents/skills/executing-plans/SKILL.md +76 -0
- package/src/repo/.agents/skills/finishing-a-development-branch/SKILL.md +200 -0
- package/src/repo/.agents/skills/gh-cli/SKILL.md +461 -0
- package/src/repo/.agents/skills/glab-cli/SKILL.md +468 -0
- package/src/repo/.agents/skills/issue-tracker/SKILL.md +119 -0
- package/src/repo/.agents/skills/linear-cli/SKILL.md +276 -0
- package/src/repo/.agents/skills/logging/SKILL.md +559 -0
- package/src/repo/.agents/skills/orient-to-recent-work/SKILL.md +43 -0
- package/src/repo/.agents/skills/ponytail/SKILL.md +101 -0
- package/src/repo/.agents/skills/ponytail-audit/SKILL.md +41 -0
- package/src/repo/.agents/skills/ponytail-debt/SKILL.md +44 -0
- package/src/repo/.agents/skills/ponytail-gain/SKILL.md +51 -0
- package/src/repo/.agents/skills/ponytail-help/SKILL.md +74 -0
- package/src/repo/.agents/skills/ponytail-review/SKILL.md +57 -0
- package/src/repo/.agents/skills/project-documentation/SKILL.md +367 -0
- package/src/repo/.agents/skills/receiving-code-review/SKILL.md +213 -0
- package/src/repo/.agents/skills/requesting-code-review/SKILL.md +105 -0
- package/src/repo/.agents/skills/requesting-code-review/code-reviewer.md +146 -0
- package/src/repo/.agents/skills/security-reviewer/SKILL.md +144 -0
- package/src/repo/.agents/skills/subagent-driven-development/SKILL.md +279 -0
- package/src/repo/.agents/skills/subagent-driven-development/code-quality-reviewer-prompt.md +20 -0
- package/src/repo/.agents/skills/subagent-driven-development/implementer-prompt.md +78 -0
- package/src/repo/.agents/skills/subagent-driven-development/spec-reviewer-prompt.md +61 -0
- package/src/repo/.agents/skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/src/repo/.agents/skills/systematic-debugging/SKILL.md +296 -0
- package/src/repo/.agents/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/src/repo/.agents/skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/src/repo/.agents/skills/systematic-debugging/defense-in-depth.md +122 -0
- package/src/repo/.agents/skills/systematic-debugging/find-polluter.sh +63 -0
- package/src/repo/.agents/skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/src/repo/.agents/skills/systematic-debugging/test-academic.md +14 -0
- package/src/repo/.agents/skills/systematic-debugging/test-pressure-1.md +58 -0
- package/src/repo/.agents/skills/systematic-debugging/test-pressure-2.md +68 -0
- package/src/repo/.agents/skills/systematic-debugging/test-pressure-3.md +69 -0
- package/src/repo/.agents/skills/test-driven-development/SKILL.md +371 -0
- package/src/repo/.agents/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/src/repo/.agents/skills/using-git-worktrees/SKILL.md +291 -0
- package/src/repo/.agents/skills/using-superpowers/SKILL.md +87 -0
- package/src/repo/.agents/skills/verification-before-completion/SKILL.md +148 -0
- package/src/repo/.agents/skills/writing-plans/SKILL.md +116 -0
- package/src/repo/.agents/skills/writing-skills/SKILL.md +655 -0
- package/src/repo/.agents/skills/writing-skills/anthropic-best-practices.md +1150 -0
- package/src/repo/.agents/skills/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
- package/src/repo/.agents/skills/writing-skills/graphviz-conventions.dot +172 -0
- package/src/repo/.agents/skills/writing-skills/persuasion-principles.md +187 -0
- package/src/repo/.agents/skills/writing-skills/render-graphs.js +168 -0
- package/src/repo/.agents/skills/writing-skills/testing-skills-with-subagents.md +384 -0
- package/src/repo/.claude/agents/admin-portal.agent.md +12 -0
- package/src/repo/.claude/agents/api-specialist.agent.md +12 -0
- package/src/repo/.claude/agents/backend-architect.agent.md +12 -0
- package/src/repo/.claude/agents/documenter.agent.md +12 -0
- package/src/repo/.claude/agents/feature-builder.agent.md +12 -0
- package/src/repo/.claude/agents/frontend-developer.agent.md +12 -0
- package/src/repo/.claude/agents/green.agent.md +12 -0
- package/src/repo/.claude/agents/implementer.agent.md +12 -0
- package/src/repo/.claude/agents/planner.agent.md +12 -0
- package/src/repo/.claude/agents/red.agent.md +12 -0
- package/src/repo/.claude/agents/refactor.agent.md +12 -0
- package/src/repo/.claude/agents/researcher.agent.md +12 -0
- package/src/repo/.claude/agents/reviewer.agent.md +12 -0
- package/src/repo/.claude/agents/tdd.agent.md +12 -0
- package/src/repo/.claude/agents-snippets/admin-portal.md +90 -0
- package/src/repo/.claude/agents-snippets/api-specialist.md +57 -0
- package/src/repo/.claude/agents-snippets/backend-architect.md +49 -0
- package/src/repo/.claude/agents-snippets/documenter.md +58 -0
- package/src/repo/.claude/agents-snippets/feature-builder.md +49 -0
- package/src/repo/.claude/agents-snippets/frontend-developer.md +49 -0
- package/src/repo/.claude/agents-snippets/green.md +18 -0
- package/src/repo/.claude/agents-snippets/implementer.md +31 -0
- package/src/repo/.claude/agents-snippets/planner.md +40 -0
- package/src/repo/.claude/agents-snippets/red.md +14 -0
- package/src/repo/.claude/agents-snippets/refactor.md +22 -0
- package/src/repo/.claude/agents-snippets/researcher.md +43 -0
- package/src/repo/.claude/agents-snippets/reviewer.md +83 -0
- package/src/repo/.claude/agents-snippets/tdd.md +18 -0
- package/src/repo/.claude/commands/assign-tasks.md +13 -0
- package/src/repo/.claude/commands/bootstrap-patch.md +15 -0
- package/src/repo/.claude/commands/bootstrap-upgrade.md +15 -0
- package/src/repo/.claude/commands/bootstrap.md +15 -0
- package/src/repo/.claude/commands/commit-push.md +13 -0
- package/src/repo/.claude/commands/constitution.md +15 -0
- package/src/repo/.claude/commands/create-skill.md +13 -0
- package/src/repo/.claude/commands/implement-feature.md +15 -0
- package/src/repo/.claude/commands/implement-fixes.md +15 -0
- package/src/repo/.claude/commands/implement.md +15 -0
- package/src/repo/.claude/commands/plan.md +15 -0
- package/src/repo/.claude/commands/playwright-test.md +13 -0
- package/src/repo/.claude/commands/ponytail-audit.md +15 -0
- package/src/repo/.claude/commands/ponytail-debt.md +15 -0
- package/src/repo/.claude/commands/ponytail-gain.md +15 -0
- package/src/repo/.claude/commands/ponytail-help.md +15 -0
- package/src/repo/.claude/commands/ponytail-review.md +15 -0
- package/src/repo/.claude/commands/ponytail.md +15 -0
- package/src/repo/.claude/commands/release-notes.md +13 -0
- package/src/repo/.claude/commands/review-pr.md +15 -0
- package/src/repo/.claude/commands/review-staged.md +15 -0
- package/src/repo/.claude/commands/review.md +15 -0
- package/src/repo/.claude/commands/specify.md +15 -0
- package/src/repo/.claude/commands/tasks.md +13 -0
- package/src/repo/.claude/prompt-snippets/assign-tasks.md +170 -0
- package/src/repo/.claude/prompt-snippets/bootstrap-patch.md +200 -0
- package/src/repo/.claude/prompt-snippets/bootstrap-upgrade.md +357 -0
- package/src/repo/.claude/prompt-snippets/bootstrap.md +1026 -0
- package/src/repo/.claude/prompt-snippets/commit-push.md +70 -0
- package/src/repo/.claude/prompt-snippets/constitution.md +57 -0
- package/src/repo/.claude/prompt-snippets/create-skill.md +490 -0
- package/src/repo/.claude/prompt-snippets/implement-feature.md +124 -0
- package/src/repo/.claude/prompt-snippets/implement-fixes.md +116 -0
- package/src/repo/.claude/prompt-snippets/implement.md +56 -0
- package/src/repo/.claude/prompt-snippets/plan.md +94 -0
- package/src/repo/.claude/prompt-snippets/playwright-test.md +58 -0
- package/src/repo/.claude/prompt-snippets/ponytail-audit.md +5 -0
- package/src/repo/.claude/prompt-snippets/ponytail-debt.md +5 -0
- package/src/repo/.claude/prompt-snippets/ponytail-gain.md +5 -0
- package/src/repo/.claude/prompt-snippets/ponytail-help.md +5 -0
- package/src/repo/.claude/prompt-snippets/ponytail-review.md +5 -0
- package/src/repo/.claude/prompt-snippets/ponytail.md +5 -0
- package/src/repo/.claude/prompt-snippets/release-notes.md +204 -0
- package/src/repo/.claude/prompt-snippets/review-pr.md +156 -0
- package/src/repo/.claude/prompt-snippets/review-staged.md +35 -0
- package/src/repo/.claude/prompt-snippets/review.md +139 -0
- package/src/repo/.claude/prompt-snippets/specify.md +84 -0
- package/src/repo/.claude/prompt-snippets/tasks.md +146 -0
- package/src/repo/.claude/rules/agent-conduct.md +13 -0
- package/src/repo/.claude/rules/api-server.md +16 -0
- package/src/repo/.claude/rules/coding-standards.md +13 -0
- package/src/repo/.claude/rules/component-structure.md +15 -0
- package/src/repo/.claude/rules/core-libraries.md +13 -0
- package/src/repo/.claude/rules/environment-tooling.md +13 -0
- package/src/repo/.claude/rules/logging-comments.md +13 -0
- package/src/repo/.claude/rules/logging.md +13 -0
- package/src/repo/.claude/rules/orient-to-recent-work.md +13 -0
- package/src/repo/.claude/rules/prisma-migrations.md +16 -0
- package/src/repo/.claude/rules/project-context.md +13 -0
- package/src/repo/.claude/rules/server-client-separation.md +13 -0
- package/src/repo/.claude/rules/subagent-workflow.md +13 -0
- package/src/repo/.claude/rules/testing-quality.md +16 -0
- package/src/repo/.claude/rules/testing.md +16 -0
- package/src/repo/.claude/rules/ui-accessibility.md +15 -0
- package/src/repo/.claude/rules/version-control.md +13 -0
- package/src/repo/.claude/rules/what-to-avoid.md +13 -0
- package/src/repo/.claude/rules-snippets/agent-conduct.md +51 -0
- package/src/repo/.claude/rules-snippets/api-server.md +7 -0
- package/src/repo/.claude/rules-snippets/coding-standards.md +45 -0
- package/src/repo/.claude/rules-snippets/component-structure.md +8 -0
- package/src/repo/.claude/rules-snippets/core-libraries.md +6 -0
- package/src/repo/.claude/rules-snippets/deployment.md +38 -0
- package/src/repo/.claude/rules-snippets/documentation.md +621 -0
- package/src/repo/.claude/rules-snippets/environment-tooling.md +6 -0
- package/src/repo/.claude/rules-snippets/logging-comments.md +4 -0
- package/src/repo/.claude/rules-snippets/logging.md +352 -0
- package/src/repo/.claude/rules-snippets/patterns.md +29 -0
- package/src/repo/.claude/rules-snippets/ponytail.md +24 -0
- package/src/repo/.claude/rules-snippets/prisma-migrations.md +8 -0
- package/src/repo/.claude/rules-snippets/project-context.md +25 -0
- package/src/repo/.claude/rules-snippets/server-client-separation.md +7 -0
- package/src/repo/.claude/rules-snippets/subagent-workflow.md +134 -0
- package/src/repo/.claude/rules-snippets/testing-quality.md +5 -0
- package/src/repo/.claude/rules-snippets/testing.md +38 -0
- package/src/repo/.claude/rules-snippets/ui-accessibility.md +7 -0
- package/src/repo/.claude/rules-snippets/version-control.md +6 -0
- package/src/repo/.claude/rules-snippets/what-to-avoid.md +8 -0
- package/src/repo/.claude/rules-snippets/workflows.md +25 -0
- package/src/repo/.claude/settings.json +7 -0
- package/src/repo/.claude/skills/README.md +50 -0
- package/src/repo/.cursor/agents/admin-portal.agent.md +11 -0
- package/src/repo/.cursor/agents/api-specialist.agent.md +11 -0
- package/src/repo/.cursor/agents/backend-architect.agent.md +11 -0
- package/src/repo/.cursor/agents/documenter.agent.md +11 -0
- package/src/repo/.cursor/agents/feature-builder.agent.md +11 -0
- package/src/repo/.cursor/agents/frontend-developer.agent.md +11 -0
- package/src/repo/.cursor/agents/green.agent.md +11 -0
- package/src/repo/.cursor/agents/implementer.agent.md +11 -0
- package/src/repo/.cursor/agents/planner.agent.md +11 -0
- package/src/repo/.cursor/agents/red.agent.md +11 -0
- package/src/repo/.cursor/agents/refactor.agent.md +11 -0
- package/src/repo/.cursor/agents/researcher.agent.md +11 -0
- package/src/repo/.cursor/agents/reviewer.agent.md +11 -0
- package/src/repo/.cursor/agents/tdd.agent.md +11 -0
- package/src/repo/.cursor/commands/assign-tasks.md +13 -0
- package/src/repo/.cursor/commands/bootstrap-patch.md +17 -0
- package/src/repo/.cursor/commands/bootstrap-upgrade.md +15 -0
- package/src/repo/.cursor/commands/bootstrap.md +17 -0
- package/src/repo/.cursor/commands/commit-push.md +15 -0
- package/src/repo/.cursor/commands/constitution.md +17 -0
- package/src/repo/.cursor/commands/create-skill.md +15 -0
- package/src/repo/.cursor/commands/implement-feature.md +17 -0
- package/src/repo/.cursor/commands/implement-fixes.md +17 -0
- package/src/repo/.cursor/commands/implement.md +17 -0
- package/src/repo/.cursor/commands/plan.md +17 -0
- package/src/repo/.cursor/commands/playwright-test.md +15 -0
- package/src/repo/.cursor/commands/ponytail-audit.md +13 -0
- package/src/repo/.cursor/commands/ponytail-debt.md +13 -0
- package/src/repo/.cursor/commands/ponytail-gain.md +13 -0
- package/src/repo/.cursor/commands/ponytail-help.md +13 -0
- package/src/repo/.cursor/commands/ponytail-review.md +13 -0
- package/src/repo/.cursor/commands/ponytail.md +13 -0
- package/src/repo/.cursor/commands/release-notes.md +15 -0
- package/src/repo/.cursor/commands/review-pr.md +17 -0
- package/src/repo/.cursor/commands/review-staged.md +10 -0
- package/src/repo/.cursor/commands/review.md +17 -0
- package/src/repo/.cursor/commands/specify.md +17 -0
- package/src/repo/.cursor/commands/tasks.md +15 -0
- package/src/repo/.cursor/mcp.json +13 -0
- package/src/repo/.cursor/rules/agent-conduct.mdc +11 -0
- package/src/repo/.cursor/rules/api-server.mdc +11 -0
- package/src/repo/.cursor/rules/coding-standards.mdc +11 -0
- package/src/repo/.cursor/rules/component-structure.mdc +11 -0
- package/src/repo/.cursor/rules/core-libraries.mdc +11 -0
- package/src/repo/.cursor/rules/environment-tooling.mdc +11 -0
- package/src/repo/.cursor/rules/logging-comments.mdc +11 -0
- package/src/repo/.cursor/rules/logging.mdc +11 -0
- package/src/repo/.cursor/rules/orient-to-recent-work.mdc +9 -0
- package/src/repo/.cursor/rules/ponytail.mdc +9 -0
- package/src/repo/.cursor/rules/prisma-migrations.mdc +11 -0
- package/src/repo/.cursor/rules/project-context.mdc +11 -0
- package/src/repo/.cursor/rules/server-client-separation.mdc +11 -0
- package/src/repo/.cursor/rules/subagent-workflow.mdc +11 -0
- package/src/repo/.cursor/rules/testing-quality.mdc +11 -0
- package/src/repo/.cursor/rules/ui-accessibility.mdc +11 -0
- package/src/repo/.cursor/rules/version-control.mdc +11 -0
- package/src/repo/.cursor/rules/what-to-avoid.mdc +11 -0
- package/src/repo/.cursor/skills/README.md +50 -0
- package/src/repo/.github/agents/admin-portal.agent.md +11 -0
- package/src/repo/.github/agents/api-specialist.agent.md +11 -0
- package/src/repo/.github/agents/backend-architect.agent.md +11 -0
- package/src/repo/.github/agents/documenter.agent.md +11 -0
- package/src/repo/.github/agents/feature-builder.agent.md +24 -0
- package/src/repo/.github/agents/frontend-developer.agent.md +11 -0
- package/src/repo/.github/agents/green.agent.md +12 -0
- package/src/repo/.github/agents/implementer.agent.md +12 -0
- package/src/repo/.github/agents/planner.agent.md +12 -0
- package/src/repo/.github/agents/red.agent.md +12 -0
- package/src/repo/.github/agents/refactor.agent.md +12 -0
- package/src/repo/.github/agents/researcher.agent.md +12 -0
- package/src/repo/.github/agents/reviewer.agent.md +11 -0
- package/src/repo/.github/agents/tdd.agent.md +13 -0
- package/src/repo/.github/copilot-instructions.md +89 -0
- package/src/repo/.github/instructions/agent-conduct.instructions.md +13 -0
- package/src/repo/.github/instructions/api-server.instructions.md +13 -0
- package/src/repo/.github/instructions/coding-standards.instructions.md +13 -0
- package/src/repo/.github/instructions/component-structure.instructions.md +13 -0
- package/src/repo/.github/instructions/core-libraries.instructions.md +13 -0
- package/src/repo/.github/instructions/deployment.instructions.md +13 -0
- package/src/repo/.github/instructions/documentation.instructions.md +14 -0
- package/src/repo/.github/instructions/environment-tooling.instructions.md +13 -0
- package/src/repo/.github/instructions/logging-comments.instructions.md +13 -0
- package/src/repo/.github/instructions/logging.instructions.md +13 -0
- package/src/repo/.github/instructions/patterns.instructions.md +13 -0
- package/src/repo/.github/instructions/prisma-migrations.instructions.md +13 -0
- package/src/repo/.github/instructions/project-context.instructions.md +13 -0
- package/src/repo/.github/instructions/server-client-separation.instructions.md +13 -0
- package/src/repo/.github/instructions/subagent-workflow.instructions.md +13 -0
- package/src/repo/.github/instructions/testing-quality.instructions.md +13 -0
- package/src/repo/.github/instructions/testing.instructions.md +13 -0
- package/src/repo/.github/instructions/ui-accessibility.instructions.md +13 -0
- package/src/repo/.github/instructions/version-control.instructions.md +13 -0
- package/src/repo/.github/instructions/what-to-avoid.instructions.md +13 -0
- package/src/repo/.github/instructions/workflows.instructions.md +13 -0
- package/src/repo/.github/prompts/assign-tasks.prompt.md +14 -0
- package/src/repo/.github/prompts/bootstrap-patch.prompt.md +16 -0
- package/src/repo/.github/prompts/bootstrap-upgrade.prompt.md +15 -0
- package/src/repo/.github/prompts/bootstrap.prompt.md +16 -0
- package/src/repo/.github/prompts/commit-push.prompt.md +14 -0
- package/src/repo/.github/prompts/constitution.prompt.md +16 -0
- package/src/repo/.github/prompts/create-skill.prompt.md +16 -0
- package/src/repo/.github/prompts/implement-feature.prompt.md +16 -0
- package/src/repo/.github/prompts/implement-fixes.prompt.md +16 -0
- package/src/repo/.github/prompts/implement.prompt.md +16 -0
- package/src/repo/.github/prompts/plan.prompt.md +16 -0
- package/src/repo/.github/prompts/playwright-test.prompt.md +14 -0
- package/src/repo/.github/prompts/ponytail-audit.prompt.md +13 -0
- package/src/repo/.github/prompts/ponytail-debt.prompt.md +13 -0
- package/src/repo/.github/prompts/ponytail-gain.prompt.md +13 -0
- package/src/repo/.github/prompts/ponytail-help.prompt.md +13 -0
- package/src/repo/.github/prompts/ponytail-review.prompt.md +13 -0
- package/src/repo/.github/prompts/ponytail.prompt.md +13 -0
- package/src/repo/.github/prompts/release-notes.prompt.md +14 -0
- package/src/repo/.github/prompts/review-pr.prompt.md +16 -0
- package/src/repo/.github/prompts/review-staged.prompt.md +16 -0
- package/src/repo/.github/prompts/review.prompt.md +16 -0
- package/src/repo/.github/prompts/specify.prompt.md +16 -0
- package/src/repo/.github/prompts/tasks.prompt.md +14 -0
- package/src/repo/.github/skills/README.md +36 -0
- package/src/repo/.mcp.json +13 -0
- package/src/repo/.opencode/agents/admin-portal.md +14 -0
- package/src/repo/.opencode/agents/api-specialist.md +14 -0
- package/src/repo/.opencode/agents/backend-architect.md +14 -0
- package/src/repo/.opencode/agents/documenter.md +14 -0
- package/src/repo/.opencode/agents/feature-builder.md +15 -0
- package/src/repo/.opencode/agents/frontend-developer.md +14 -0
- package/src/repo/.opencode/agents/green.md +14 -0
- package/src/repo/.opencode/agents/implementer.md +14 -0
- package/src/repo/.opencode/agents/planner.md +14 -0
- package/src/repo/.opencode/agents/red.md +14 -0
- package/src/repo/.opencode/agents/refactor.md +14 -0
- package/src/repo/.opencode/agents/researcher.md +14 -0
- package/src/repo/.opencode/agents/reviewer.md +14 -0
- package/src/repo/.opencode/agents/tdd.md +15 -0
- package/src/repo/.opencode/commands/assign-tasks.md +16 -0
- package/src/repo/.opencode/commands/bootstrap-patch.md +18 -0
- package/src/repo/.opencode/commands/bootstrap-upgrade.md +18 -0
- package/src/repo/.opencode/commands/bootstrap.md +18 -0
- package/src/repo/.opencode/commands/commit-push.md +16 -0
- package/src/repo/.opencode/commands/constitution.md +18 -0
- package/src/repo/.opencode/commands/create-skill.md +16 -0
- package/src/repo/.opencode/commands/implement-feature.md +18 -0
- package/src/repo/.opencode/commands/implement-fixes.md +20 -0
- package/src/repo/.opencode/commands/implement.md +18 -0
- package/src/repo/.opencode/commands/plan.md +18 -0
- package/src/repo/.opencode/commands/playwright-test.md +16 -0
- package/src/repo/.opencode/commands/ponytail-audit.md +10 -0
- package/src/repo/.opencode/commands/ponytail-debt.md +10 -0
- package/src/repo/.opencode/commands/ponytail-gain.md +10 -0
- package/src/repo/.opencode/commands/ponytail-help.md +10 -0
- package/src/repo/.opencode/commands/ponytail-review.md +10 -0
- package/src/repo/.opencode/commands/ponytail.md +10 -0
- package/src/repo/.opencode/commands/release-notes.md +16 -0
- package/src/repo/.opencode/commands/review-pr.md +18 -0
- package/src/repo/.opencode/commands/review-staged.md +11 -0
- package/src/repo/.opencode/commands/review.md +18 -0
- package/src/repo/.opencode/commands/specify.md +18 -0
- package/src/repo/.opencode/commands/tasks.md +16 -0
- package/src/repo/.opencode/opencode.json +9 -0
- package/src/repo/.opencode/plugins/ponytail.mjs +79 -0
- package/src/repo/.opencode/rules/agent-conduct.md +11 -0
- package/src/repo/.opencode/rules/api-server.md +11 -0
- package/src/repo/.opencode/rules/coding-standards.md +11 -0
- package/src/repo/.opencode/rules/component-structure.md +11 -0
- package/src/repo/.opencode/rules/core-libraries.md +11 -0
- package/src/repo/.opencode/rules/environment-tooling.md +11 -0
- package/src/repo/.opencode/rules/logging-comments.md +11 -0
- package/src/repo/.opencode/rules/logging.md +11 -0
- package/src/repo/.opencode/rules/ponytail.md +3 -0
- package/src/repo/.opencode/rules/prisma-migrations.md +11 -0
- package/src/repo/.opencode/rules/project-context.md +11 -0
- package/src/repo/.opencode/rules/server-client-separation.md +11 -0
- package/src/repo/.opencode/rules/subagent-workflow.md +11 -0
- package/src/repo/.opencode/rules/testing-quality.md +11 -0
- package/src/repo/.opencode/rules/ui-accessibility.md +11 -0
- package/src/repo/.opencode/rules/version-control.md +11 -0
- package/src/repo/.opencode/rules/what-to-avoid.md +11 -0
- package/src/repo/.vscode/mcp.json +13 -0
- package/src/repo/AGENTS.md +387 -0
- package/src/repo/CLAUDE.md +51 -0
- package/src/repo/README.md +145 -0
- package/src/repo/docs/api/README.md +82 -0
- package/src/repo/docs/architecture/README.md +56 -0
- package/src/repo/docs/features/README.md +82 -0
- package/src/repo/docs/fixes/README.md +117 -0
- package/src/repo/hooks/claude-codex-hooks.json +31 -0
- package/src/repo/hooks/copilot-hooks.json +21 -0
- package/src/repo/hooks/ponytail-activate.js +91 -0
- package/src/repo/hooks/ponytail-config.js +122 -0
- package/src/repo/hooks/ponytail-instructions.js +92 -0
- package/src/repo/hooks/ponytail-mode-tracker.js +55 -0
- package/src/repo/hooks/ponytail-runtime.js +51 -0
- package/src/repo/hooks/ponytail-statusline.ps1 +21 -0
- package/src/repo/hooks/ponytail-statusline.sh +12 -0
- package/src/repo/templates/README.md +80 -0
- package/src/repo/templates/adr.template.md +162 -0
- package/src/repo/templates/complex-fix-plan.template.md +162 -0
- package/src/repo/templates/complex-fix-spec.template.md +163 -0
- package/src/repo/templates/feature-plan.template.md +202 -0
- package/src/repo/templates/feature-spec.template.md +148 -0
- package/src/repo/templates/monthly-fix-log.template.md +91 -0
|
@@ -0,0 +1,387 @@
|
|
|
1
|
+
# AGENTS.md - {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
**Language:** {{LANGUAGE}}
|
|
4
|
+
**Framework:** {{FRAMEWORK}}
|
|
5
|
+
**Package Manager:** {{PACKAGE_MANAGER}}
|
|
6
|
+
**Deploy:** {{DEPLOY_PLATFORM}} | **Dev:** localhost:{{DEV_PORT}}
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
{{PROJECT_DESCRIPTION}}
|
|
11
|
+
|
|
12
|
+
## Orientation to recent work
|
|
13
|
+
|
|
14
|
+
The [orient-to-recent-work](.agents/skills/orient-to-recent-work/SKILL.md) skill (auto-loaded) orients you to recent project activity before any non-trivial task: CHANGELOG Unreleased, recent commits, recent decisions. Skip for trivial fixes: typos, version bumps, isolated docs updates, mechanical refactors with a known target.
|
|
15
|
+
|
|
16
|
+
## Structure
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
{{PROJECT_NAME}}/
|
|
20
|
+
{{PROJECT_STRUCTURE}}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Tech Stack
|
|
24
|
+
|
|
25
|
+
**Core:** {{LANGUAGE}}, {{FRAMEWORK}}
|
|
26
|
+
**Database:** {{DATABASE}}
|
|
27
|
+
**Testing:** {{TEST_FRAMEWORK}}
|
|
28
|
+
**Build:** {{BUILD_TOOL}}
|
|
29
|
+
|
|
30
|
+
## Project Management
|
|
31
|
+
|
|
32
|
+
**Tracker:** {{ISSUE_TRACKER}}
|
|
33
|
+
**URL:** {{PM_URL}}
|
|
34
|
+
**Project Key:** {{PROJECT_KEY}}
|
|
35
|
+
**Issue Key Format:** `{{PM_ISSUE_KEY}}`
|
|
36
|
+
|
|
37
|
+
### Tool Access
|
|
38
|
+
|
|
39
|
+
See the `issue-tracker` skill (`.agents/skills/issue-tracker/SKILL.md`) for MCP tool prefixes, CLI fallback strategy, tracker configuration, and epic discovery workflow.
|
|
40
|
+
For CLI command reference, see the matching skill: `.agents/skills/{acli,gh-cli,glab-cli,bkt-cli,linear-cli}/SKILL.md`.
|
|
41
|
+
|
|
42
|
+
## Agent Conduct & Interaction Rules
|
|
43
|
+
|
|
44
|
+
### Clarification & Alignment Guidelines
|
|
45
|
+
|
|
46
|
+
#### 1. Proactive Clarification
|
|
47
|
+
|
|
48
|
+
- **Identify Ambiguity**: Stop and ask if a task lacks clear acceptance criteria, inputs, or expected outputs.
|
|
49
|
+
- **Resolve Conflicts**: Flag conflicting instructions between the user prompt, existing code, and documentation before writing code.
|
|
50
|
+
- **Expose Assumptions**: State your assumptions clearly and ask for validation before proceeding with high-impact changes.
|
|
51
|
+
|
|
52
|
+
#### 2. Technical Validation & Alternatives
|
|
53
|
+
|
|
54
|
+
- **Propose Better Paths**: Suggest a simpler, more performant, or more idiomatic alternative if you see a better way to solve the problem.
|
|
55
|
+
- **Flag Code Smells**: Alert the team if the requested changes introduce technical debt, anti-patterns, or break existing architectural rules.
|
|
56
|
+
- **Check Dependencies**: Ask for verification if a task requires adding new third-party libraries or upgrading existing versions.
|
|
57
|
+
|
|
58
|
+
#### 3. Scope & Edge Case Management
|
|
59
|
+
|
|
60
|
+
- **Surface Edge Cases**: List potential failures, null states, or security risks you discover, and ask how to handle them.
|
|
61
|
+
- **Prevent Scope Creep**: Ask for permission before modifying files or logic outside the explicit scope of the assigned task.
|
|
62
|
+
- **Clarify Breakages**: Warn the user immediately if a requested change will intentionally break backward compatibility or existing APIs.
|
|
63
|
+
|
|
64
|
+
#### 4. How to Ask Questions (Response Formatting)
|
|
65
|
+
|
|
66
|
+
When stopping to ask a question, do not just post an open-ended block of text. Format your query using one of these two structures:
|
|
67
|
+
|
|
68
|
+
- **Structured Multiple-Choice**: For architectural, design, or logic choices, provide a numbered list of distinct options. Include a brief pro/con or trade-off for each path so the user can quickly respond with just a number (e.g., "Go with Option 2").
|
|
69
|
+
- **Targeted Text Input**: For missing data, API endpoints, or environment variables, provide a clear, pre-formatted Markdown template or fill-in-the-blank block. The user should be able to copy, fill out, and return it with minimal friction.
|
|
70
|
+
|
|
71
|
+
### Guardrails
|
|
72
|
+
|
|
73
|
+
- **Never silently change** database schemas, API contracts, or auth flows without confirmation
|
|
74
|
+
- **Never assume scope** — if a task says "add search," ask whether it means basic text search, full-text search, or filter/facet search
|
|
75
|
+
- **Never skip tests** for assumed-correct behavior — confirm expectations first
|
|
76
|
+
- **Prefer reversible changes** when acting without full clarity
|
|
77
|
+
|
|
78
|
+
> **Full details:** See `.github/instructions/agent-conduct.instructions.md`
|
|
79
|
+
|
|
80
|
+
## Detailed Instructions
|
|
81
|
+
|
|
82
|
+
Detailed standards are split into focused instruction files in `.github/instructions/`:
|
|
83
|
+
|
|
84
|
+
| Instruction File | Description |
|
|
85
|
+
| ---------------------------------- | ----------------------------------------------- |
|
|
86
|
+
| `agent-conduct.instructions.md` | Agent conduct rules, clarification protocols |
|
|
87
|
+
| `project-context.instructions.md` | Project architecture and data flow |
|
|
88
|
+
| `coding-standards.instructions.md` | Coding standards, patterns, and conventions |
|
|
89
|
+
| `patterns.instructions.md` | State management, API, and component patterns |
|
|
90
|
+
| `workflows.instructions.md` | Development commands and environment setup |
|
|
91
|
+
| `testing.instructions.md` | Testing standards, commands, and conventions |
|
|
92
|
+
| `deployment.instructions.md` | Deployment configuration and commands |
|
|
93
|
+
| `logging.instructions.md` | Structured logging standards and best practices |
|
|
94
|
+
| `documentation.instructions.md` | Feature and fix documentation standards |
|
|
95
|
+
|
|
96
|
+
## Skills
|
|
97
|
+
|
|
98
|
+
For detailed standards on specific topics, refer to these skills in `.agents/skills/`:
|
|
99
|
+
|
|
100
|
+
| Skill | File | Purpose |
|
|
101
|
+
| -------------------- | ----------------------------------------- | ---------------------------------------------------------- |
|
|
102
|
+
| **Atlassian CLI** | `acli/SKILL.md` | Atlassian CLI (ACLI) command reference |
|
|
103
|
+
| **Bitbucket CLI** | `bkt-cli/SKILL.md` | Bitbucket PRs, issues, repos CLI reference |
|
|
104
|
+
| **Brainstorming** | `brainstorming/SKILL.md` | Structured ideation sessions |
|
|
105
|
+
| **Branch Finish** | `finishing-a-development-branch/SKILL.md` | Completing and merging branches |
|
|
106
|
+
| **Code Review** | `requesting-code-review/SKILL.md` | Review process and checklists |
|
|
107
|
+
| **Code Simplifier** | `code-simplifier/SKILL.md` | Analyze recently modified code for simplification opportunities |
|
|
108
|
+
| **Debugging** | `systematic-debugging/SKILL.md` | Structured debugging methodology |
|
|
109
|
+
| **Debugger** | `debugger/SKILL.md` | Systematic debugging dispatch with mandatory root cause investigation |
|
|
110
|
+
| **Documentation** | `project-documentation/SKILL.md` | README, comments, ADRs, changelogs |
|
|
111
|
+
| **Executing Plans** | `executing-plans/SKILL.md` | Following through on implementation plans |
|
|
112
|
+
| **Git Worktrees** | `using-git-worktrees/SKILL.md` | Parallel development branches |
|
|
113
|
+
| **GitHub CLI** | `gh-cli/SKILL.md` | GitHub Issues CLI command reference |
|
|
114
|
+
| **GitLab CLI** | `glab-cli/SKILL.md` | GitLab MRs, issues, pipelines CLI reference |
|
|
115
|
+
| **Issue Tracker** | `issue-tracker/SKILL.md` | MCP tools reference, CLI fallback strategy, epic discovery |
|
|
116
|
+
| **Linear CLI** | `linear-cli/SKILL.md` | Linear CLI command reference |
|
|
117
|
+
| **Logging** | `logging/SKILL.md` | Structured logging standards, log levels, observability |
|
|
118
|
+
| **Orient to Recent Work** | `orient-to-recent-work/SKILL.md` | Build context from recent project activity |
|
|
119
|
+
| **Parallel Agents** | `dispatching-parallel-agents/SKILL.md` | Coordinating multiple AI agents |
|
|
120
|
+
| **Ponytail** | `ponytail/SKILL.md` | YAGNI/stdlib/native/minimum-discipline coding mode |
|
|
121
|
+
| **Ponytail Audit** | `ponytail-audit/SKILL.md` | Whole-repo audit for over-engineering |
|
|
122
|
+
| **Ponytail Debt** | `ponytail-debt/SKILL.md` | Track ponytail shortcuts and deferrals |
|
|
123
|
+
| **Ponytail Gain** | `ponytail-gain/SKILL.md` | Show ponytail's measured impact |
|
|
124
|
+
| **Ponytail Help** | `ponytail-help/SKILL.md` | Quick-reference for ponytail modes and commands |
|
|
125
|
+
| **Ponytail Review** | `ponytail-review/SKILL.md` | Code review focused on over-engineering |
|
|
126
|
+
| **Review Feedback** | `receiving-code-review/SKILL.md` | Responding constructively to review feedback |
|
|
127
|
+
| **Security Reviewer** | `security-reviewer/SKILL.md` | Security-focused code review |
|
|
128
|
+
| **Subagent Dev** | `subagent-driven-development/SKILL.md` | Breaking tasks into subagent chunks |
|
|
129
|
+
| **Superpowers** | `using-superpowers/SKILL.md` | Leveraging the full skill system |
|
|
130
|
+
| **TDD** | `test-driven-development/SKILL.md` | Test-driven development with red-green-refactor |
|
|
131
|
+
| **Verification** | `verification-before-completion/SKILL.md` | Quality checks before claiming work done |
|
|
132
|
+
| **Writing Plans** | `writing-plans/SKILL.md` | Feature planning and specifications |
|
|
133
|
+
| **Writing Skills** | `writing-skills/SKILL.md` | Creating effective SKILL.md files |
|
|
134
|
+
|
|
135
|
+
## ⚠️ CRITICAL: Orchestration Checkpoint (READ FIRST)
|
|
136
|
+
|
|
137
|
+
**BEFORE starting ANY multi-step task, MUST read this section:**
|
|
138
|
+
|
|
139
|
+
If your work involves **2+ of these activities**, you MUST use orchestrator-first flow:
|
|
140
|
+
|
|
141
|
+
- Research / exploration
|
|
142
|
+
- Planning / specification
|
|
143
|
+
- Implementation / code changes
|
|
144
|
+
- Testing / validation
|
|
145
|
+
- Review / quality gate
|
|
146
|
+
|
|
147
|
+
**Common patterns requiring orchestration:**
|
|
148
|
+
|
|
149
|
+
- Feature development (research + build + test + review)
|
|
150
|
+
- Bug fix analysis (diagnose + plan + implement + validate)
|
|
151
|
+
- API design (spec + implement + integrate + test)
|
|
152
|
+
- Multi-file refactoring (plan + change multiple files + validate)
|
|
153
|
+
|
|
154
|
+
**Quick decision tree:**
|
|
155
|
+
|
|
156
|
+
- Single file edit? → Direct implementation OK
|
|
157
|
+
- 2+ independent fixes? → Use subagent flow (dispatch parallel agents)
|
|
158
|
+
- Feature with planning + implementation + review? → Use Feature Builder coordinator
|
|
159
|
+
- Behavior-driven development? → Use TDD coordinator
|
|
160
|
+
- Uncertain? → Read "Recommended Flow" below
|
|
161
|
+
|
|
162
|
+
**Cost of skipping this:**
|
|
163
|
+
|
|
164
|
+
- Wastes tokens on sequential work that could parallelize
|
|
165
|
+
- Breaks established workflow expectations
|
|
166
|
+
- Loses benefits of specialist domain routing
|
|
167
|
+
- Reduces code review quality (less context isolation)
|
|
168
|
+
- Single-agent work accumulates cognitive load
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## Preferred Workflow: Orchestrator + Subagents
|
|
173
|
+
|
|
174
|
+
**Use a coordinator agent (orchestrator) as the default approach for non-trivial work.** Coordinators break complex tasks into focused subtasks and dispatch specialized subagents, each with context isolation and domain expertise.
|
|
175
|
+
|
|
176
|
+
### When to use orchestrator + subagents
|
|
177
|
+
|
|
178
|
+
- Features spanning multiple files or domains
|
|
179
|
+
- Tasks requiring planning → implementation → review cycles
|
|
180
|
+
- Work that benefits from domain specialization (backend, frontend, API)
|
|
181
|
+
- Any task with 2+ independent subtasks
|
|
182
|
+
|
|
183
|
+
### When to use a single agent directly
|
|
184
|
+
|
|
185
|
+
- Quick one-file fixes or small edits
|
|
186
|
+
- Research questions that don't require code changes
|
|
187
|
+
- Ad-hoc code reviews (invoke Reviewer directly)
|
|
188
|
+
- Simple documentation updates
|
|
189
|
+
|
|
190
|
+
### Subagent Guidance
|
|
191
|
+
|
|
192
|
+
Use custom agents when you want explicit coordinator and worker roles. Use workflow skills when you want tighter manual control over the same process.
|
|
193
|
+
|
|
194
|
+
#### When to Delegate
|
|
195
|
+
|
|
196
|
+
- Use `Feature Builder` for feature work that needs research, planning, implementation, and review in one coordinated flow.
|
|
197
|
+
- Use `TDD` when requirements are behavior-driven and you want explicit red-green-refactor execution.
|
|
198
|
+
- Prefer orchestrator-first execution for multi-step work and route tasks to domain specialists when possible.
|
|
199
|
+
- Use `Researcher` directly for read-only exploration.
|
|
200
|
+
- Use `Backend Architect`, `Frontend Developer`, `API Specialist`, `Admin Portal`, and `Documenter` for focused domain tasks.
|
|
201
|
+
- Use `subagent-driven-development` after `writing-plans` when you have a written implementation plan and want to stay in the current session.
|
|
202
|
+
- Use `dispatching-parallel-agents` only when tasks are independent, do not share state, and are unlikely to touch the same files.
|
|
203
|
+
- Use `requesting-code-review` after each task in subagent-driven development, after each major task in ad-hoc work, and before merge so issues do not cascade.
|
|
204
|
+
- Use `executing-plans` instead of `subagent-driven-development` when you want a separate execution session rather than same-session orchestration.
|
|
205
|
+
|
|
206
|
+
#### Operating Rules
|
|
207
|
+
|
|
208
|
+
- Give each subagent a narrow scope, the exact task text, and the context it needs to act safely.
|
|
209
|
+
- Treat `Planner`, `Implementer`, `Reviewer`, `Red`, `Green`, and `Refactor` as worker agents intended for coordinator-led handoff.
|
|
210
|
+
- Do not make an implementation subagent read the plan file on its own; pass the relevant task directly.
|
|
211
|
+
- In `subagent-driven-development`, keep the review order strict: spec compliance first, then code quality.
|
|
212
|
+
- If a reviewer finds issues, fix them and re-run the same review before moving on.
|
|
213
|
+
- Do not run multiple implementation subagents in parallel when they could touch shared packages, shared docs, or the same app surface.
|
|
214
|
+
|
|
215
|
+
#### Recommended Flow
|
|
216
|
+
|
|
217
|
+
1. Use `brainstorming` if requirements or scope are still fuzzy.
|
|
218
|
+
2. Use `writing-plans` to produce a concrete implementation plan.
|
|
219
|
+
3. Use `subagent-driven-development` for same-session execution or `executing-plans` for a separate execution session.
|
|
220
|
+
4. Use `dispatching-parallel-agents` only for independent investigations or non-overlapping tasks.
|
|
221
|
+
5. Use `requesting-code-review` and `verification-before-completion` before claiming the work is done.
|
|
222
|
+
|
|
223
|
+
> **Delegation patterns:** See `.github/instructions/subagent-workflow.instructions.md`.
|
|
224
|
+
|
|
225
|
+
### How to invoke
|
|
226
|
+
|
|
227
|
+
- "Use the Feature Builder agent to implement this feature" → Coordinator orchestrates full lifecycle
|
|
228
|
+
- "Run the TDD agent for this requirement" → TDD coordinator manages red-green-refactor
|
|
229
|
+
- "Use the Backend Architect to design the database schema" → Domain specialist works directly
|
|
230
|
+
- "Review my recent changes" → Reviewer works directly on git diff
|
|
231
|
+
|
|
232
|
+
## Sub-Agent Patterns
|
|
233
|
+
|
|
234
|
+
Use the appropriate sub-agents when the task benefits from specialized expertise or parallel execution.
|
|
235
|
+
|
|
236
|
+
### When to use sub-agents
|
|
237
|
+
|
|
238
|
+
| Context | Recommended Agent | Why |
|
|
239
|
+
| ---------------------------------------- | ------------------------------------------------------------ | ------------------------------------- |
|
|
240
|
+
| Orchestration and coordination | `orchestrator` or `coordinator` or `delegator` or equivalent | Strategic planning and task breakdown |
|
|
241
|
+
| Code base exploration and analysis | `explorer` or equivalent | Focused on understanding codebases |
|
|
242
|
+
| Codebase understanding and documentation | `documenter` or equivalent | Focused on generating documentation |
|
|
243
|
+
| Reviewing templates for quality | `reviewer` or equivalent | Read-only, focused on standards |
|
|
244
|
+
| Implementing template changes | `developer` or `fixer` or equivalent | Needs write access, follows workflows |
|
|
245
|
+
| Planning architecture decisions | `planner` or `consul` or equivalent | Read-only, strategic thinking |
|
|
246
|
+
| PR code review | `reviewer` or equivalent | Structured review process |
|
|
247
|
+
| Commit and push | `build` or `deployer` or equivalent | Execution-focused |
|
|
248
|
+
| UI design and prototyping | `designer` or equivalent | Visual and UX expertise |
|
|
249
|
+
|
|
250
|
+
### Sub-agent invocation patterns
|
|
251
|
+
|
|
252
|
+
**Claude Code** (via `.claude/agents/` or plugins in target projects):
|
|
253
|
+
|
|
254
|
+
```
|
|
255
|
+
@reviewer Review the coding standards template
|
|
256
|
+
@developer Implement the new placeholder syntax
|
|
257
|
+
@planner Design the monorepo structure
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
**GitHub Copilot** (via `.github/agents/` or plugins in target projects):
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
@reviewer Review the coding standards template
|
|
264
|
+
@developer Implement the new placeholder syntax
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
**OpenCode** (via `.opencode/agents/` or plugins in target projects):
|
|
268
|
+
|
|
269
|
+
```
|
|
270
|
+
@reviewer Review the coding standards template
|
|
271
|
+
@developer Implement the new placeholder syntax
|
|
272
|
+
@planner Design the monorepo structure
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### Sub-agent guidelines
|
|
276
|
+
|
|
277
|
+
1. **Choose the right agent** — Match the agent's role to the task
|
|
278
|
+
2. **Provide context** — Reference the relevant rules-snippets or prompt-snippets
|
|
279
|
+
3. **Set constraints** — Use tool restrictions for read-only agents (researcher, reviewer)
|
|
280
|
+
4. **Chain when needed** — Planner → Developer → Reviewer for complex changes
|
|
281
|
+
|
|
282
|
+
## Custom Agents (Subagents)
|
|
283
|
+
|
|
284
|
+
Custom agents enable **context-isolated delegation** — a coordinator agent breaks complex tasks into subtasks and dispatches specialized subagents, each with their own tools and focus.
|
|
285
|
+
|
|
286
|
+
### Available Agents
|
|
287
|
+
|
|
288
|
+
Agent definitions live in `.github/agents/` (GitHub Copilot), `.cursor/agents/` (Cursor), and `.opencode/` (OpenCode):
|
|
289
|
+
|
|
290
|
+
#### Coordinators
|
|
291
|
+
|
|
292
|
+
Coordinators orchestrate workflows by dispatching worker and specialist agents.
|
|
293
|
+
|
|
294
|
+
| Agent | Tools | Agents | Purpose |
|
|
295
|
+
| ------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
|
296
|
+
| **Feature Builder** | agent, edit, search, read | Planner, Implementer, Reviewer, Researcher, Backend Architect, Frontend Developer, API Specialist, Admin Portal, Documenter | End-to-end feature development orchestration |
|
|
297
|
+
| **TDD** | agent, edit, search, read | Red, Green, Refactor | Red-green-refactor cycle coordination |
|
|
298
|
+
|
|
299
|
+
#### Domain Specialists
|
|
300
|
+
|
|
301
|
+
Specialists have deep expertise in a specific domain. They can be invoked directly or dispatched by coordinators.
|
|
302
|
+
|
|
303
|
+
| Agent | Tools | Purpose |
|
|
304
|
+
| ---------------------- | ---------------------------- | ------------------------------------------------------- |
|
|
305
|
+
| **Backend Architect** | read, search, edit, terminal | API design, databases, system architecture, security |
|
|
306
|
+
| **Frontend Developer** | read, search, edit, terminal | UI components, state management, responsive design |
|
|
307
|
+
| **API Specialist** | read, search, edit, terminal | API contracts, documentation, versioning, integration |
|
|
308
|
+
| **Admin Portal** | read, search, edit, terminal | RBAC, dashboards, reporting, analytics, monitoring |
|
|
309
|
+
| **Documenter** | read, search, edit, terminal | AGENTS.md, README, API docs, architecture documentation |
|
|
310
|
+
| **Reviewer** | read, search, terminal | Multi-perspective code review (also usable directly) |
|
|
311
|
+
|
|
312
|
+
#### Process Workers
|
|
313
|
+
|
|
314
|
+
Workers are dispatched by coordinators and are not directly user-invocable.
|
|
315
|
+
|
|
316
|
+
| Agent | Tools | Purpose |
|
|
317
|
+
| --------------- | ---------------------------- | --------------------------------------------- |
|
|
318
|
+
| **Planner** | read, search, edit, terminal | Break down features into implementation tasks |
|
|
319
|
+
| **Implementer** | read, search, edit, terminal | Write production code following TDD |
|
|
320
|
+
| **Researcher** | read, search | Codebase analysis without changes |
|
|
321
|
+
| **Red** | read, search, edit, terminal | Write failing tests (TDD red phase) |
|
|
322
|
+
| **Green** | read, search, edit, terminal | Write minimal code to pass tests (TDD green) |
|
|
323
|
+
| **Refactor** | read, search, edit, terminal | Improve code quality, keep tests green |
|
|
324
|
+
|
|
325
|
+
### Orchestration Patterns
|
|
326
|
+
|
|
327
|
+
**Coordinator → Specialist/Worker**: Feature Builder dispatches domain specialists (Backend Architect, Frontend Developer, etc.) based on the task domain, and process workers (Planner, Reviewer, Researcher) for workflow stages.
|
|
328
|
+
|
|
329
|
+
**Domain Matching**: Choose the specialist whose expertise matches the task:
|
|
330
|
+
|
|
331
|
+
- Backend changes → Backend Architect
|
|
332
|
+
- UI changes → Frontend Developer
|
|
333
|
+
- API contracts/docs → API Specialist
|
|
334
|
+
- Admin dashboards, RBAC, reporting, monitoring → Admin Portal
|
|
335
|
+
- General implementation → Implementer
|
|
336
|
+
|
|
337
|
+
**Sequential**: Tasks with dependencies are implemented one at a time.
|
|
338
|
+
**Parallel**: Independent tasks can be dispatched to multiple subagents simultaneously.
|
|
339
|
+
|
|
340
|
+
### Invoking Subagents
|
|
341
|
+
|
|
342
|
+
Subagents are typically **agent-initiated** — the coordinator decides when to delegate. You can also hint:
|
|
343
|
+
|
|
344
|
+
- "Use the Feature Builder agent to implement this feature"
|
|
345
|
+
- "Run the TDD agent for this requirement"
|
|
346
|
+
- "Use the Backend Architect to design the database schema"
|
|
347
|
+
- "Use the Documenter to update the project documentation"
|
|
348
|
+
- "Use a subagent to research how authentication works in this codebase"
|
|
349
|
+
|
|
350
|
+
> **Docs:** [VS Code Subagents](https://code.visualstudio.com/docs/copilot/agents/subagents) · [Cursor Subagents](https://cursor.com/docs/subagents)
|
|
351
|
+
|
|
352
|
+
## Documentation Requirements
|
|
353
|
+
|
|
354
|
+
Documentation updates are **mandatory before committing** any feature or fix. See [`.github/instructions/documentation.instructions.md`](.github/instructions/documentation.instructions.md) for the full pre-commit checklist, templates, and AI agent directives.
|
|
355
|
+
|
|
356
|
+
**Quick summary:**
|
|
357
|
+
|
|
358
|
+
- Create or update `docs/features/{{ISSUE_ID}}-{{FEATURE_NAME}}/` (spec + plan) for every feature
|
|
359
|
+
- Add fixes to the monthly log in `docs/fixes/{{YYYY-MM}}.md` (or a dedicated folder for complex fixes)
|
|
360
|
+
- Update `docs/api/`, `docs/integration/`, `docs/guides/`, `README.md`, and `CHANGELOG.md` when applicable
|
|
361
|
+
- Reference `docs/constitution.md` for project principles and governance
|
|
362
|
+
- Include all doc changes in the same commit/PR as the code
|
|
363
|
+
|
|
364
|
+
## Contributing
|
|
365
|
+
|
|
366
|
+
**Standards:** Follow {{FRAMEWORK}} and {{LANGUAGE}} best practices
|
|
367
|
+
**Process:** Feature branch → spec/plan docs → tests → implementation → update docs → lint → build → PR
|
|
368
|
+
|
|
369
|
+
## Related Documentation
|
|
370
|
+
|
|
371
|
+
- [README.md](README.md) - Project overview
|
|
372
|
+
- [docs/](docs/) - Detailed documentation
|
|
373
|
+
- [.claude/rules/](.claude/rules/) - Claude Code rules (thin wrappers → rules-snippets)
|
|
374
|
+
- [.claude/commands/](.claude/commands/) - Claude Code commands (thin wrappers → prompt-snippets)
|
|
375
|
+
- [.claude/rules-snippets/](.claude/rules-snippets/) - Rules content (source of truth)
|
|
376
|
+
- [.claude/prompt-snippets/](.claude/prompt-snippets/) - Prompt content (source of truth)
|
|
377
|
+
- [.claude/agents-snippets/](.claude/agents-snippets/) - Agent definitions (source of truth)
|
|
378
|
+
- [.github/instructions/](.github/instructions/) - Copilot instructions (thin wrappers → rules-snippets)
|
|
379
|
+
- [.github/prompts/](.github/prompts/) - Copilot prompts (thin wrappers → prompt-snippets)
|
|
380
|
+
- [.github/agents/](.github/agents/) - Copilot agents (thin wrappers → agents-snippets)
|
|
381
|
+
- [.cursor/rules/](.cursor/rules/) - Cursor IDE rules (thin wrappers → rules-snippets)
|
|
382
|
+
- [.cursor/commands/](.cursor/commands/) - Cursor commands (thin wrappers → prompt-snippets)
|
|
383
|
+
- [.cursor/agents/](.cursor/agents/) - Cursor agents (thin wrappers → agents-snippets)
|
|
384
|
+
- [.opencode/rules/](.opencode/rules/) - OpenCode rules (thin wrappers → rules-snippets)
|
|
385
|
+
- [.opencode/commands/](.opencode/commands/) - OpenCode commands (thin wrappers → prompt-snippets)
|
|
386
|
+
- [.opencode/agents/](.opencode/agents/) - OpenCode agents (thin wrappers → agents-snippets)
|
|
387
|
+
- [.opencode/opencode.json](.opencode/opencode.json) - OpenCode configuration
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
@AGENTS.md
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
- Install: `{{INSTALL_COMMAND}}`
|
|
8
|
+
- Dev: `{{DEV_COMMAND}}`
|
|
9
|
+
- Build: `{{BUILD_COMMAND}}`
|
|
10
|
+
- Test: `{{TEST_COMMAND}}`
|
|
11
|
+
- Lint: `{{LINT_COMMAND}}`
|
|
12
|
+
|
|
13
|
+
## Stack
|
|
14
|
+
|
|
15
|
+
- {{LANGUAGE}} with {{FRAMEWORK}}
|
|
16
|
+
- Database: {{DATABASE}}
|
|
17
|
+
- Testing: {{TEST_FRAMEWORK}}
|
|
18
|
+
- Package manager: {{PACKAGE_MANAGER}}
|
|
19
|
+
|
|
20
|
+
## Claude Code
|
|
21
|
+
|
|
22
|
+
- Rules are in `.claude/rules/` — they load automatically each session.
|
|
23
|
+
- Detailed standards are in `.github/instructions/`.
|
|
24
|
+
- Agent definitions are in `.github/agents/` (shared with Copilot).
|
|
25
|
+
- Custom commands are in `.claude/commands/`.
|
|
26
|
+
- Skills are in `.agents/skills/`.
|
|
27
|
+
- See `AGENTS.md` for full project context, orchestration checkpoint, and agent hierarchy.
|
|
28
|
+
- See `.github/instructions/` for detailed standards (coding, testing, deployment, logging, etc.).
|
|
29
|
+
|
|
30
|
+
## GitHub Copilot
|
|
31
|
+
|
|
32
|
+
- Instructions are in `.github/instructions/` — they power completions and chat.
|
|
33
|
+
- Agents are in `.github/agents/`.
|
|
34
|
+
- Prompts are in `.github/prompts/`.
|
|
35
|
+
- MCP config is in `.vscode/mcp.json`.
|
|
36
|
+
|
|
37
|
+
## Cursor IDE
|
|
38
|
+
|
|
39
|
+
- Rules are in `.cursor/rules/` (.mdc format).
|
|
40
|
+
- Agents are in `.cursor/agents/`.
|
|
41
|
+
- Commands are in `.cursor/commands/`.
|
|
42
|
+
- MCP config is in `.cursor/mcp.json`.
|
|
43
|
+
|
|
44
|
+
## OpenCode
|
|
45
|
+
|
|
46
|
+
- Config is in `.opencode/opencode.json`.
|
|
47
|
+
- Commands are in `.opencode/commands/`.
|
|
48
|
+
- Rules are in `.opencode/rules/`.
|
|
49
|
+
- Agents are in `.opencode/agents/`.
|
|
50
|
+
- Instructions are loaded from `AGENTS.md`, `.github/instructions/`, and `.claude/rules/`.
|
|
51
|
+
- Skills are loaded from `.agents/skills/` and `.claude/skills/`.
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
# {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
{{PROJECT_DESCRIPTION}}
|
|
4
|
+
|
|
5
|
+
## Common Placeholders
|
|
6
|
+
|
|
7
|
+
Templates use `{{PLACEHOLDER}}` syntax (SCREAMING_SNAKE_CASE). The most common placeholders:
|
|
8
|
+
|
|
9
|
+
| Placeholder | Description |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| `{{PROJECT_NAME}}` | Project name |
|
|
12
|
+
| `{{FRAMEWORK}}` | Primary framework (Next.js, Nuxt, Laravel, Django, etc.) |
|
|
13
|
+
| `{{LANGUAGE}}` | Programming language (TypeScript, PHP, Python, C#, etc.) |
|
|
14
|
+
| `{{PACKAGE_MANAGER}}` | Package manager (npm, pnpm, composer, pip, etc.) |
|
|
15
|
+
| `{{DEV_PORT}}` | Development server port |
|
|
16
|
+
| `{{DEPLOY_PLATFORM}}` | Deployment target |
|
|
17
|
+
| `{{ISSUE_TRACKER}}` | Issue tracker (Jira, Linear, GitHub Issues) |
|
|
18
|
+
| `{{ISSUE_ID}}` | Issue or ticket identifier |
|
|
19
|
+
| `{{FEATURE_NAME}}` | Feature name |
|
|
20
|
+
| `{{PROJECT_DESCRIPTION}}` | Short project description |
|
|
21
|
+
| `{{DEFAULT_BRANCH}}` | Default git branch (e.g., main) |
|
|
22
|
+
| `{{REPO_URL}}` | Repository URL |
|
|
23
|
+
| `{{SRC_DIR}}` | Source directory |
|
|
24
|
+
| `{{TEST_DIR}}` | Test directory |
|
|
25
|
+
| `{{FILE_EXTENSION}}` | Primary source file extension |
|
|
26
|
+
|
|
27
|
+
Individual templates and skills may use additional placeholders; those are documented in the template's own header or README.
|
|
28
|
+
|
|
29
|
+
## Tech Stack
|
|
30
|
+
|
|
31
|
+
- **Framework:** {{FRAMEWORK}}
|
|
32
|
+
- **Language:** {{LANGUAGE}}
|
|
33
|
+
- **Styling:** {{STYLING}}
|
|
34
|
+
- **Package Manager:** {{PACKAGE_MANAGER}}
|
|
35
|
+
|
|
36
|
+
## Template Placeholders
|
|
37
|
+
|
|
38
|
+
The following placeholders must be replaced when customizing this template:
|
|
39
|
+
|
|
40
|
+
| Placeholder | Description |
|
|
41
|
+
| ----------------------- | ---------------------------------------------------------- |
|
|
42
|
+
| {{PROJECT_NAME}} | Project name (kebab-case). |
|
|
43
|
+
| {{PROJECT_DESCRIPTION}} | Short description of the project. |
|
|
44
|
+
| {{FRAMEWORK}} | Primary framework (with version if applicable). |
|
|
45
|
+
| {{LANGUAGE}} | Primary programming language (with version if applicable). |
|
|
46
|
+
| {{STYLING}} | Styling solution (e.g., Tailwind, CSS Modules). |
|
|
47
|
+
| {{PACKAGE_MANAGER}} | Package manager (npm, pnpm, yarn, bun). |
|
|
48
|
+
| {{NODE_VERSION}} | Required Node.js version. |
|
|
49
|
+
| {{REPO_URL}} | Repository URL. |
|
|
50
|
+
| {{DEV_PORT}} | Development server port. |
|
|
51
|
+
| {{SRC_STRUCTURE}} | High-level source folder structure. |
|
|
52
|
+
| {{LICENSE_TYPE}} | License identifier (e.g., MIT, Apache-2.0). |
|
|
53
|
+
| {{SRC_DIR}} | Source directory (e.g., src, app, lib). |
|
|
54
|
+
| {{TEST_DIR}} | Test directory (e.g., tests, test, spec). |
|
|
55
|
+
| {{FILE_EXTENSION}} | Primary file extension (e.g., ts, js, tsx). |
|
|
56
|
+
| {{DEFAULT_BRANCH}} | Default git branch (e.g., main, master). |
|
|
57
|
+
|
|
58
|
+
## Getting Started
|
|
59
|
+
|
|
60
|
+
### Prerequisites
|
|
61
|
+
|
|
62
|
+
- Node.js {{NODE_VERSION}}
|
|
63
|
+
- {{PACKAGE_MANAGER}}
|
|
64
|
+
|
|
65
|
+
### Installation
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
# Clone the repository
|
|
69
|
+
git clone {{REPO_URL}}
|
|
70
|
+
cd {{PROJECT_NAME}}
|
|
71
|
+
|
|
72
|
+
# Install dependencies
|
|
73
|
+
{{PACKAGE_MANAGER}} install
|
|
74
|
+
|
|
75
|
+
# Start development server
|
|
76
|
+
{{PACKAGE_MANAGER}} run dev
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
The development server will start at `http://localhost:{{DEV_PORT}}`.
|
|
80
|
+
|
|
81
|
+
## Project Structure
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
{{PROJECT_NAME}}/
|
|
85
|
+
├── src/
|
|
86
|
+
│ ├── {{SRC_STRUCTURE}}
|
|
87
|
+
├── tests/
|
|
88
|
+
├── docs/
|
|
89
|
+
├── .cursor/ # Cursor IDE configuration
|
|
90
|
+
├── .github/ # GitHub configuration
|
|
91
|
+
└── package.json
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Scripts
|
|
95
|
+
|
|
96
|
+
| Command | Description |
|
|
97
|
+
| ------------------------------- | ------------------------ |
|
|
98
|
+
| `{{PACKAGE_MANAGER}} run dev` | Start development server |
|
|
99
|
+
| `{{PACKAGE_MANAGER}} run build` | Build for production |
|
|
100
|
+
| `{{PACKAGE_MANAGER}} run test` | Run tests |
|
|
101
|
+
| `{{PACKAGE_MANAGER}} run lint` | Run linter |
|
|
102
|
+
|
|
103
|
+
## Development
|
|
104
|
+
|
|
105
|
+
See the following files for AI-assisted development:
|
|
106
|
+
|
|
107
|
+
- [AGENTS.md](AGENTS.md) - AI agent context
|
|
108
|
+
- [.cursor/rules/](.cursor/rules/) - Cursor IDE rules
|
|
109
|
+
- [.github/copilot-instructions.md](.github/copilot-instructions.md) - GitHub Copilot instructions
|
|
110
|
+
|
|
111
|
+
## AI Instructions and Commands
|
|
112
|
+
|
|
113
|
+
This repository includes AI instruction files to standardize development workflows across tools. The `.cursor/` and `.github/` folders define how AI assistants should analyze, plan, implement, and review changes.
|
|
114
|
+
|
|
115
|
+
### Planning
|
|
116
|
+
|
|
117
|
+
- `/specify` — Create or refine a feature specification.
|
|
118
|
+
- `/plan` — Produce an implementation plan with steps and dependencies.
|
|
119
|
+
- `/tasks` — Break work into actionable tasks.
|
|
120
|
+
- `/assign-tasks` — Convert requirements into tickets in `{{ISSUE_TRACKER}}`.
|
|
121
|
+
|
|
122
|
+
### Implementing
|
|
123
|
+
|
|
124
|
+
- `/implement-feature` — Implement a feature from tasks/specs with validation.
|
|
125
|
+
- `/implement-fixes` — Apply focused bug fixes with testing and PR notes.
|
|
126
|
+
|
|
127
|
+
### Reviewing
|
|
128
|
+
|
|
129
|
+
- `/review` — Run a structured code review checklist for changes.
|
|
130
|
+
- `/review-pr` — Review pull requests with architecture, testing, and security checks.
|
|
131
|
+
|
|
132
|
+
### Code Management
|
|
133
|
+
|
|
134
|
+
- `/commit-push` — Create conventional commits and push safely to a feature branch.
|
|
135
|
+
|
|
136
|
+
## Contributing
|
|
137
|
+
|
|
138
|
+
1. Create a feature branch
|
|
139
|
+
2. Make your changes
|
|
140
|
+
3. Run tests and linting
|
|
141
|
+
4. Submit a pull request
|
|
142
|
+
|
|
143
|
+
## License
|
|
144
|
+
|
|
145
|
+
{{LICENSE_TYPE}}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# API Documentation
|
|
2
|
+
|
|
3
|
+
This folder contains API specifications and documentation.
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
api/
|
|
9
|
+
├── README.md # This file
|
|
10
|
+
├── overview.md # API overview and conventions
|
|
11
|
+
├── authentication.md # Authentication details
|
|
12
|
+
└── endpoints/ # Individual endpoint documentation
|
|
13
|
+
├── users.md
|
|
14
|
+
├── posts.md
|
|
15
|
+
└── ...
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Documentation Standards
|
|
19
|
+
|
|
20
|
+
### Endpoint Documentation
|
|
21
|
+
|
|
22
|
+
Each endpoint should document:
|
|
23
|
+
|
|
24
|
+
- **HTTP Method and Path**
|
|
25
|
+
- **Description**
|
|
26
|
+
- **Authentication requirements**
|
|
27
|
+
- **Request parameters** (path, query, body)
|
|
28
|
+
- **Response format**
|
|
29
|
+
- **Error responses**
|
|
30
|
+
- **Examples**
|
|
31
|
+
|
|
32
|
+
### Example Format
|
|
33
|
+
|
|
34
|
+
```markdown
|
|
35
|
+
## GET /api/{{RESOURCE}}/:id
|
|
36
|
+
|
|
37
|
+
Retrieve a single {{RESOURCE}} by ID.
|
|
38
|
+
|
|
39
|
+
### Authentication
|
|
40
|
+
|
|
41
|
+
Required: Bearer token
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
| Name | Type | In | Required | Description |
|
|
46
|
+
| ---- | ------ | ---- | -------- | ------------------- |
|
|
47
|
+
| id | string | path | Yes | The {{RESOURCE}} ID |
|
|
48
|
+
|
|
49
|
+
### Response
|
|
50
|
+
|
|
51
|
+
**Success (200)**
|
|
52
|
+
\`\`\`json
|
|
53
|
+
{
|
|
54
|
+
"id": "123",
|
|
55
|
+
"name": "Example",
|
|
56
|
+
"createdAt": "2026-01-01T00:00:00Z"
|
|
57
|
+
}
|
|
58
|
+
\`\`\`
|
|
59
|
+
|
|
60
|
+
**Error (404)**
|
|
61
|
+
\`\`\`json
|
|
62
|
+
{
|
|
63
|
+
"error": "Not found",
|
|
64
|
+
"message": "{{RESOURCE}} with id '123' not found"
|
|
65
|
+
}
|
|
66
|
+
\`\`\`
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## API Versioning
|
|
70
|
+
|
|
71
|
+
Document the API versioning strategy:
|
|
72
|
+
|
|
73
|
+
- URL versioning: `/api/v1/resource`
|
|
74
|
+
- Header versioning: `API-Version: 1`
|
|
75
|
+
- Query versioning: `/api/resource?version=1`
|
|
76
|
+
|
|
77
|
+
## OpenAPI/Swagger
|
|
78
|
+
|
|
79
|
+
If using OpenAPI, place the specification file here:
|
|
80
|
+
|
|
81
|
+
- `openapi.yaml` or `openapi.json`
|
|
82
|
+
- Link to interactive documentation (e.g., Swagger UI)
|