Contributing to notcrawl
September 22, 2026 ยท View on GitHub
Keep real Notion workspace data, secrets, tokens, cookies, and exported private content out of git.
Useful local checks:
make check
Run make help to see the credential-free snapshot and other repository
targets. Official releases use the unified GitHub Actions workflow described
in Distribution; local release targets refuse publication.
CI runs tests on Linux, macOS, and Windows. Linux and macOS also exercise the
built CLI through make smoke. Lint checks dead code both with and without
tests, so test-only helpers cannot keep unused production paths alive.
Snapshot validation uses GoReleaser 2.18.2, pinned in the CI workflow.
Implementation notes:
- read Notion Desktop data through snapshots only
- prefer stable normalized rows plus raw source payloads
- keep Markdown rendering deterministic
- add comments only where Notion-specific behavior is not obvious
- keep
README.md,SPEC.md, and examples in sync