Developer Documentation¶

Documentation for contributors and developers working on RequireKit.

For Contributors¶

Architecture ¶

System architecture, design patterns, and technical decisions.

Architecture Decision Records ¶

Historical record of important architectural decisions.

Contributing ¶

Guidelines for contributing code, documentation, or examples.

Templates ¶

Templates and patterns for extending RequireKit.

Quick Links¶

System Architecture - High-level architecture overview
ADR Index - All architecture decisions
Contributing Guide - How to contribute
Templates - Implementation templates

Repository Structure¶

require-kit/
├── docs/                    # Documentation
│   ├── requirements/        # EARS requirements
│   ├── bdd/                # BDD scenarios
│   ├── epics/              # Epic specifications
│   ├── features/           # Feature specifications
│   └── guides/             # User guides
├── installer/              # Installation scripts
│   └── global/
│       ├── agents/         # Global agents
│       └── commands/       # Global commands
└── .claude/               # User-specific config (gitignored)

Development Setup¶

Fork and clone the repository
Review architecture documentation
Check contributing guidelines
Make changes and test
Submit pull request

Key Components¶

Requirements Analyst Agent¶

Interactive Q&A for gathering requirements.

Location: installer/global/agents/requirements-analyst.md

BDD Generator Agent¶

Generates Gherkin scenarios from EARS requirements.

Location: installer/global/agents/bdd-generator.md

Epic/Feature Commands¶

Commands for hierarchy management.

Location: installer/global/commands/