SWARM Epics¶
This directory tracks large multi-milestone initiatives (epics) in the SWARM project.
Active Epics¶
- AgentHub Recon - Research-scout integration plan for using AgentHub as a SWARM collaboration substrate (Status: Scoping, Est: 1-2d for M0-M1)
- SciAgentGym Integration - Integration with SciAgentGym benchmarking framework (Status: Planning, Est: 0.5d)
Epic Format¶
Each epic document includes:
- Summary: High-level description and purpose
- Goals: Key objectives
- Milestones: Breakdown of work into tracked phases
- Dependencies: External and internal dependencies
- Success Criteria: Definition of done
- Architecture Details: Technical design and event flow
- Risks and Open Questions: Known issues and unresolved questions
- Timeline: Estimated completion schedule
- References: Related papers, repos, and documentation
Creating a New Epic¶
- Use the GitHub issue template:
.github/ISSUE_TEMPLATE/epic.yml - Create epic document in this directory:
docs/epics/{epic-name}.md - Link from this README
- Update as milestones progress
Completed Epics¶
Completed epics are archived in the project CHANGELOG.