Skip to content

Contributing

HoraDomu edited this page Jun 19, 2026 · 1 revision

Contributing

Ways to contribute

  • Add patterns — the highest-value contribution; see Patterns
  • Write tests — coverage gaps are tracked in the open issues
  • Report false positives — open an issue with the pattern name and a sanitized example
  • Improve docs — edit this wiki or the README

Dev setup

git clone https://github.com/HoraDomu/Atheon.git
cd Atheon
go mod download
go test ./...

Rebuilding the pattern bundle

After adding or editing patterns in community/:

go run ./bundler
go test ./...

Running CI checks locally

go vet ./...
go test ./... -race -coverprofile=coverage.out
go tool cover -func=coverage.out | grep total:

Coverage must stay above 45%.

PR checklist

  • go test ./... passes
  • go vet ./... clean
  • New patterns have a corresponding test or sample that validates the regex
  • No secrets or real credentials in test fixtures

Clone this wiki locally