diff --git a/docs/report-format.md b/docs/report-format.md new file mode 100644 index 00000000..b1eeb9fd --- /dev/null +++ b/docs/report-format.md @@ -0,0 +1,17 @@ +# JSON report (sketch) + +```json +{ + "version": 1, + "verdict": "pass" | "fail", + "findings": [ + {"rule": "max-function-length", "path": "internal/diff/diff.go", + "line": 42, "severity": "warn"} + ] +} +``` + +## Open questions + +- Do we emit findings with score 0, or omit them? +- Should the text report be generated from this, or stay hand-written?