Menu

#140 docs: add agent-friendly section to CONTRIBUTING.md

closed
nobody
None
2026-04-20
2026-04-16
Anonymous
No

Originally created by: kumaakh

Background

CONTRIBUTING.md exists but lacks guidance for AI agents contributing to the repo. As fleet itself is used to run agent sprints against this codebase, contributors (human and AI) need to know the agent-specific context.

What to add

A new "For AI agents" section covering:

  • Dev-mode install: `npm run build && node dist/index.js install` to test changes locally
  • Which files are safe to edit freely vs. which need care:
  • `src/` — TypeScript source, always rebuild after changes
  • `skills/` — skill markdown files, no build needed, picked up at runtime
  • `CLAUDE.md` — agent context for Claude Code contributors, also source for `llms.txt`
  • `hooks/` — shell hooks, test manually
  • How to test skill changes: edit `skills/fleet/` or `skills/pm/`, run `/mcp` to reload, verify in conversation
  • Sprint branches follow `sprint/<description>` or `feat/<description>` naming</description></description>
  • PM skill and fleet skill are the orchestration layer — changes there affect all active sprints

Related

Tickets: #135
Tickets: #143

Discussion

  • Anonymous

    Anonymous - 2026-04-20

    Originally posted by: kumaakh

    Fixed. CONTRIBUTING.md has a "For AI Agents" section (line 77) covering dev-mode install, safe-to-edit files, skill change workflow, and sprint branch naming conventions.

     
  • Anonymous

    Anonymous - 2026-04-20

    Ticket changed by: kumaakh

    • status: open --> closed
     

Log in to post a comment.

MongoDB Logo MongoDB