Summary
CONTRIBUTING.md lacks any documentation on how to create new rules or metrics — the primary extensibility surface of the product. Contributors have no reference for:
- DSL syntax for
.md rule files (required fields, condition operators, threshold declarations)
- Structure of
.metric.md files
- How to test a rule locally before submitting
- Trust flow for local rule development
Fix
Add a "Creating Rules and Metrics" section to CONTRIBUTING.md with:
- Annotated minimal rule example (
.md)
- Annotated minimal metric example (
.metric.md)
- Local testing workflow
- Link to existing rules/metrics as references
Effort estimate
~3 hours
Summary
CONTRIBUTING.mdlacks any documentation on how to create new rules or metrics — the primary extensibility surface of the product. Contributors have no reference for:.mdrule files (required fields, condition operators, threshold declarations).metric.mdfilesFix
Add a "Creating Rules and Metrics" section to
CONTRIBUTING.mdwith:.md).metric.md)Effort estimate
~3 hours