From 3cdcb9871f6ed6e7031cf6ad354a42130a5c6515 Mon Sep 17 00:00:00 2001
From: Cian Brennan <JakiYanko4650@hotmail.com>
Date: Tue, 13 Oct 2026 21:56:13 +0530
Subject: [PATCH] docs: sketch the JSON report format

---
 docs/report-format.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 docs/report-format.md

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?