CONTRIBUTING.md

Contributing to ctx

Thank you for your interest in contributing.

Dev environment setup

git clone https://github.com/stevesolun/ctx && cd ctx
python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e ".[dev]"

To also run the similarity/embedding tests (requires ~100 MB model download):

pip install -e ".[dev,embeddings]"

Running tests

pytest -q                          # fast suite (skips integration)
pytest -q -m 'not integration'     # same, explicit
pytest -q -m integration           # embedding precision/recall tests
pytest --cov=src -q                # with coverage report

Code style

Both ruff and mypy must pass before a PR is merged.

ruff check src/          # linting
ruff format --check src/ # formatting check
mypy src/                # type checking

Fix formatting in one shot:

ruff format src/
ruff check --fix src/

Commit conventions

This repo uses Conventional Commits:

feat:     new feature
fix:      bug fix
refactor: code restructuring without behaviour change
docs:     documentation only
test:     test additions or corrections
chore:    maintenance (deps, CI, tooling)
perf:     performance improvement
ci:       CI/CD changes

Scope is optional but encouraged, e.g. feat(intake): add fuzzy-match gate.

Reporting bugs

Open an issue at https://github.com/stevesolun/ctx/issues. Include:

• Python version and OS
• Full traceback
• Minimal reproduction steps

Pull request process

1. Fork the repo and create a feature branch from main.
2. Make your changes. Add or update tests — the CI gate requires the existing suite to pass.
3. Ensure ruff and mypy pass locally.
4. Open a PR against main. Fill in the PR template.
5. A maintainer will review and merge once CI is green.