Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (21 loc) · 931 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 931 Bytes
Raw

Contributing

This is a young project — the risk-score formula, mode ladder, and notes interop in particular are all first-pass heuristics documented as such in docs/METRICS.md. If you've run this against a real repo for a while and have data suggesting different constants or a better weighting, that's the most useful kind of contribution right now.

Local dev

node bin/ledger.mjs status      # from inside any git repo
node bin/ledger.mjs mode standard
node bin/ledger.mjs update
node bin/ledger.mjs report

No build step, no dependencies to install — bin/ledger.mjs runs directly under Node 18+.

Before opening a PR

  • If you change the ledger schema, update docs/DATA-MODEL.md in the same PR and bump package.json's version.
  • If you change what a mode level does, update the table in docs/MODES.md — it's meant to be the single source of truth, not the code comments.