Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (18 loc) · 997 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 997 Bytes
Raw

Contributing

WickBench welcomes focused fixes and measurement-analysis improvements.

Before opening a change

  1. Reduce the behavior to the smallest CSV and JSON plan that reproduce it.
  2. Add a test that fails for the current behavior.
  3. Implement the smallest change that makes the test pass.
  4. Run uv run python scripts/check.py.

Do not add universal candle-safety limits, a hosted account system, recipe or inventory management, camera interpretation, hardware control, telemetry, or an AI dependency. A new metric or a changed formula requires a specification and report-schema update because it changes user-visible evidence.

Compatibility surfaces

  • CSV and plan fields in docs/spec.md.
  • CLI exit codes 0, 1, and 2.
  • JSON schema_version: 1 and metric meanings.
  • Deterministic candidate ordering for identical input and version.

Pull requests should state the changed behavior, the evidence command run, and whether the report contract changes.