Contributing

Prerequisites

• Python 3.11+
• uv package manager
• Git

Local Development

# Clone the repository
git clone https://github.com/Zts0hg/codexspec.git
cd codexspec

# Install development dependencies
uv sync --dev

# Run locally
uv run codexspec --help

# Run tests
uv run pytest

# Lint code
uv run ruff check src/

Documentation

# Install docs dependencies
uv sync --extra docs

# Preview documentation locally
uv run mkdocs serve

# Build documentation
uv run mkdocs build

Building

uv build

Pull Request Process

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and linting
5. Submit a pull request

Code Style

• Line length: 120 characters max
• Follow PEP 8
• Use type hints for public functions