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 --extra 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 dev --extra docs
# Preview documentation locally
uv run mkdocs serve
# Build documentation
uv run mkdocs build --strict
Building¶
Pull Request Process¶
- Fork the repository
- Create a feature branch
- Make your changes
- Run tests and linting
- Submit a pull request
Code Style¶
- Line length: 120 characters max
- Follow PEP 8
- Use type hints for public functions
Read CLAUDE.md, AGENTS.md, and Repository Layout before changing templates, packaging, or initialization. Distributed command and skill copies are generated installation artifacts; edit their authoritative sources and regenerate them.