Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (59 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

78 lines (59 loc) · 2.83 KB
Raw

Contributing to diffctx

Getting Started

git clone https://github.com/nikolay-e/diffctx.git
cd diffctx
rustup component add rustfmt clippy
uv sync --locked --no-build --extra dev --extra full --extra mcp
source .venv/bin/activate
pre-commit install && pre-commit install --hook-type commit-msg

uv.lock is the resolved dependency set every CI job installs, via this exact command — --locked fails instead of re-resolving, so a pyproject edit that was not locked cannot reach a green build. Regenerate with uv lock and commit the result in the same change. --no-build takes every dependency from a wheel, so no third-party setup.py executes during install; the root project is exempt and still compiles through maturin, which is the one build this repo means to run.

The package builds the Rust extension via maturin; uv provisions the build backend in its own isolated environment, so nothing has to be installed before the sync. rust-toolchain.toml pins the compiler but deliberately not rustfmt/clippy — pinning components makes rustup install them before anything can build the crate, which breaks installing from an sdist on a machine that already has them. The rustup component add above is what the pre-commit hooks need.

Development Workflow

  1. Create a branch: feature/description or fix/description
  2. Make changes
  3. Run tests: pytest (and cargo test --lib for Rust changes)
  4. Run linting: pre-commit run --all-files
  5. Submit a pull request against main

Testing

The Python suite is integration-only — no mocking, real filesystems and real git repositories. The Rust core carries inline #[test] units plus a YAML-based declarative integration suite.

pytest                          # run all Python tests
pytest -x                       # stop on first failure
pytest tests/test_basic.py      # run specific test file

cd crates/diffctx-native
cargo test --lib                                             # Rust inline units
DIFFCTX_YAML_CASES_LIMIT=20 cargo test --test yaml_cases     # sampled YAML corpus

CI gates the full YAML corpus per-case against crates/diffctx-native/tests/known_below_threshold.txt (bidirectional: a listed case that starts passing also fails — claim improvements by removing the entry in the same commit).

Code Style

  • Formatting: black (line-length 130)
  • Linting: ruff
  • Type checking: mypy --strict
  • No docstrings or inline comments explaining "what" — code must be self-documenting

Commit Messages

Follow Conventional Commits — e.g. fix: handle empty directories in diff context. The commit-msg hook enforces the format.

Reporting Bugs

Use the bug report template.

Security Vulnerabilities

See SECURITY.md.