Developer Documentation
July 21, 2025 ยท View on GitHub
โ Back to Documentation Home | Documentation Index
Comprehensive developer documentation for contributing to and extending the Claude PM Framework
๐ Documentation Overview
This section contains detailed technical documentation for developers working with the Claude PM Framework - whether you're contributing to the core, building extensions, or integrating with other systems.
๐ Documentation Structure
API Documentation
Complete API reference for all framework components.
- Core API - Core system APIs and interfaces
- Agent API - Agent development and interaction APIs
- Services API - Service layer documentation
- Utilities API - Helper functions and utilities
- Events API - Event system and messaging
Extension Development
Guides for extending the framework with custom functionality.
- Creating Custom Agents - Build your own specialized agents
- Plugin Development - Create reusable plugins
- Integration Guide - Connect with external systems
- Hook System - Extend framework behavior
- Custom Commands - Add CLI commands
Contributing
Everything you need to contribute to the project.
- Development Setup - Get your environment ready
- Code Standards - Coding conventions and style
- Testing Guide - Write and run tests
- Pull Request Guide - Submit your changes
- Documentation Guide - Help improve docs
Architecture
Deep dives into the framework's design and implementation.
- System Overview - High-level architecture
- Agent Architecture - How agents work internally
- Communication Protocol - Inter-agent messaging
- State Management - System state handling
- Security Model - Security architecture
๐ Developer Quick Start
Setting Up Development Environment
-
Clone and Setup (15 minutes)
git clone https://github.com/bobmatnyc/claude-multiagent-pm.git cd claude-multiagent-pm npm install -
Run Tests (5 minutes)
npm test -
Build Your First Agent (30 minutes)
- Use the agent template
- Implement core methods
- Test your agent
-
- Follow code standards
- Write tests
- Open a PR
๐ก Common Development Tasks
By Goal
- Add a Feature: Contributing Guide โ Pull Request Guide
- Fix a Bug: Development Setup โ Testing Guide
- Create an Agent: Custom Agents Guide โ Agent API
- Build Integration: Integration Guide โ Services API
- Improve Performance: Architecture Overview โ Performance Tips
- Publish to PyPI: PyPI Publication Guide โ Release Process
By Component
- Core System: Core API | System Architecture
- Agent System: Agent API | Agent Architecture
- CLI Interface: Commands Guide | CLI Architecture
- Service Layer: Services API | Service Patterns
๐ Version Information
- Framework Version: 0.7.0
- Node.js Requirement: โฅ16.0.0
- Python Requirement: โฅ3.8.0
- Documentation Updated: 2025-07-18
๐ค Contributing Guidelines
Code Contributions
- Read Code Standards
- Follow Development Setup
- Write tests per Testing Guide
- Submit via Pull Request Guide
Documentation Contributions
- Follow Documentation Guide
- Use clear, concise language
- Include code examples
- Keep versions updated
๐ง Developer Resources
Tools & Utilities
- Development Scripts - Helpful automation
- Debugging Tools - Debug effectively
- Performance Profiling - Find bottlenecks
- Test Utilities - Testing helpers
References
- Glossary - Technical terms
- FAQ - Common questions
- Troubleshooting - Common issues
- Changelog - Version history
๐ Getting Help
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Security: Security Policy