docs: add CONTRIBUTING.md with the pre-commit verification checklist

Split by Python vs frontend, matches exactly what CI actually gates
(make lint/typecheck, tsc/eslint/prettier/vitest/build) so it doesn't
drift into its own source of truth. Also notes what the lint-staged
pre-commit hook already covers (ruff, prettier) vs what's still manual
(mypy, eslint, tests), and why the mypy/eslint ratchets exist.

README's Poetry mention was stale (repo uses uv) — fixed in passing,
and pointed its Contributing section at the new file instead of
duplicating instructions.
This commit is contained in:
dextmorgn
2026-08-25 09:33:37 +02:00
parent 58a3c39f0b
commit a284e4446f
2 changed files with 55 additions and 1 deletions
+53
View File
@@ -0,0 +1,53 @@
# Contributing
Setup instructions live in the [README](./README.md#development-setup). This file covers what to run before committing.
## Before every commit
Run the checks for whatever you touched, not just the file you think is affected. mypy and eslint both regularly surface issues in neighboring files once you touch something they import.
### Python (`flowsint-core`, `flowsint-types`, `flowsint-enrichers`, `flowsint-api`)
From the repo root:
```bash
make lint # ruff format --check + ruff check, whole repo
make typecheck # mypy, ratcheted to files this branch touches vs origin/main
```
Then, for whichever package(s) you changed:
```bash
cd <package> && uv run pytest -q
```
`make lint-fix` applies ruff's safe autofixes if `make lint` complains.
### Frontend (`flowsint-app`)
From `flowsint-app/`:
```bash
npx tsc --noEmit # types
npx eslint <files you touched> # lint must be 0 errors (warnings are fine)
npx prettier --check <files> # format (--write to fix)
npx vitest run # unit tests
yarn build # full build
```
## What the pre-commit hook does for you
`lint-staged` runs automatically on `git commit` and handles:
- `**/*.py` → `ruff format` + `ruff check --fix`
- `flowsint-app/**/*.{ts,tsx,js,jsx}` → `prettier --write`
It does **not** run mypy, eslint, or any test suite. Those are on you before pushing.
## Why the ratchets
`make typecheck` and the frontend eslint CI job only gate files your branch actually changed, not the whole repo. Both codebases have a real pre-existing backlog (mypy: workspace-wide cross-package imports aren't fully typed yet; eslint: ~100 pre-existing `no-explicit-any` warnings). Gating everything from day one would make every unrelated PR red. Touch a file, and it's expected to pass strict checks; untouched files stay as they are until someone gets to them.
## Commit style
Atomic commits please. one logical change per commit, not a single "fix everything" dump. Write commit messages that explain *why*, not just what changed line-by-line.
+2 -1
View File
@@ -312,9 +312,10 @@ uv run pytest
## Contributing
1. Follow the modular structure
2. Use Poetry for dependency management
2. Use [uv](https://docs.astral.sh/uv/) for dependency management
3. Write tests for new functionality
4. Update documentation as needed
5. See [CONTRIBUTING.md](./CONTRIBUTING.md) for the checks to run before committing
---