CONTRIBUTING.md

Contributing to Claude Forge

Thanks for your interest in contributing to Claude Forge!

Quick Start

Prerequisites: Python 3.11–3.13 and uv.

git clone <repo-url>
cd claude-forge
uv sync
pre-commit install

Run tests before submitting:

make test-unit        # Fast unit tests (~30s)
make lint             # Ruff linter
make type-check       # mypy

Submitting Changes

1. Branch from main
2. Make your changes with tests
3. Run make test-unit and make lint
4. Open a PR targeting main

Developer Guide

The full developer guide lives in docs/developer/:

• Developer README — setup, testing, architecture, common tasks
• Coding Standards — Python conventions, type safety, comments
• Testing Guidelines — test organization, fixtures, Docker
• Documentation Guidelines — doc structure, writing style

Reporting Issues

• Use GitHub Issues for bug reports and feature requests
• Include reproduction steps and expected vs actual behavior
• For security issues, email the maintainers directly (do not open a public issue)

License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.