Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (47 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 2.41 KB
Raw

Contributing to polyagent-skills

How to Contribute

Before You Start: Gated Development Lifecycle

Before implementing any skill or feature, follow the gated development lifecycle in common-skills/development-lifecycle-gates.md.

Gates: G0 Discovery → G1 Requirements → G2 Design → G3 POC/Spike → G4 Implementation → G5 Review → G6 Ship

Check agent.todo.md for gate status on any ongoing work. Start at the earliest incomplete gate.

Adding a New Skill

  1. Write a spec first — Create docs/specs/<skill-name>-spec.md using the spec template
  2. Create the skill directory — mkdir -p skills/<skill-name>/references
  3. Write SKILL.md — Follow the Skill Format Spec
  4. Update adapters — Run polyagentctl sync-adapters
  5. Test with at least 2 agents — Verify the skill works with different agents
  6. Submit a PR with the spec + skill + updated adapters

Adding a New Adapter

  1. Check the Adapter Contract Spec
  2. Create adapters/<agent-name>/ with the agent's instruction file
  3. Add the new agent to install_project_cmd in scripts/polyagentctl.py
  4. Write an ADR if the agent requires special handling
  5. Submit a PR

Updating Install Flows

All install logic lives in scripts/polyagentctl.py. If your change affects installation:

  1. Update install_global_cmd, install_project_cmd, or uninstall_global_cmd in scripts/polyagentctl.py
  2. Update documentation references in README.md and KNOWN_ISSUES.md

Proposing a Significant Change

  1. Write an RFC
  2. Open a PR with the RFC for discussion
  3. Once approved, implement and reference the RFC

Reporting Issues

Use the GitHub issue templates:

  • Bug Report — Skill doesn't work with a specific agent
  • Skill Request — Propose a new skill
  • Agent Support — Request support for a new agent

Conventions

  • All skill logic lives in skills/, never in adapters
  • Common patterns go in common-skills/
  • Architecture decisions get an ADR
  • Specs before implementation
  • Test with multiple agents before merging

Commit Messages

Follow conventional commits:

feat: add mail-summarizer skill
fix: correct adapter path resolution for Kiro
docs: add ADR for MCP integration decision
chore: update sync-adapters script