File size: 1,907 Bytes
21ff762 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | # Contributing to ctx
Thank you for your interest in contributing.
## Dev environment setup
```bash
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):
```bash
pip install -e ".[dev,embeddings]"
```
## Running tests
```bash
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.
```bash
ruff check src/ # linting
ruff format --check src/ # formatting check
mypy src/ # type checking
```
Fix formatting in one shot:
```bash
ruff format src/
ruff check --fix src/
```
## Commit conventions
This repo uses [Conventional Commits](https://www.conventionalcommits.org/):
```
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.
|