Contributor guide¶
The canonical contributor guide lives in CONTRIBUTING.md at the repo root. This page is a short orientation for readers of the documentation site.
Quick links¶
- Full guide:
CONTRIBUTING.md - Code of conduct:
CODE_OF_CONDUCT.md - Security reports:
SECURITY.md - Architecture map: Architecture
Three things to know¶
- PR titles must follow Conventional Commits. A
pr-checks.ymlworkflow enforces it.feat(runner): parallelize scanners- good.Changes- bad. make cimust be green locally before you push. CI runs the same gates; passing locally is the fast feedback loop.- New scanners need pinned SHA256 hashes for every platform you claim to support. Lintel will refuse to run unverified binaries, and we will not merge an adapter without pins. See adding a scanner.
Areas that need review beyond two approvals¶
These paths have CODEOWNERS guarding them and require reviews from the listed teams in addition to regular maintainer approval:
internal/resolve/- binary resolution and SHA256 verificationinternal/checker/- all scanner adaptersinternal/config/defaults_spec.go- default pins and scanner definitionsinternal/cli/run.go- the override and audit-log flow.github/workflows/release.yml- the signing workflow
Changes here are deliberately slower to merge. That is the point - the integrity of the whole tool rests on these paths.