diff --git a/README.md b/README.md index a37d833..e50422d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # hackathon-curator -Run the algo server: +**Grand Prize winner of the Man vs. Machine hackathon featured in [Wired](https://www.wired.com/story/san-francisco-hackathon-man-vs-machine/).** + +Curator is a tiny toolkit that captures GitHub diffs, scores every token for risk, and overlays a heatmap so reviewers immediately see what matters. + +## Product screenshots + +![Run Curator button on a GitHub pull request](docs/screenshots/pr-run-curator.svg) + +![Token risk heatmap overlay on diff content](docs/screenshots/heatmap-overlay.svg) + +![Curator reviewer panel with highlighted diffs](docs/screenshots/curator-sidebar.svg) + +![Curator flow from diff capture to reviewer guidance](docs/screenshots/curator-flow.svg) + +## Run the algo server ``` cd algo npm install @@ -8,7 +22,7 @@ npm run dev # localhost:3005 ``` -Run the test server: +## Run the test server ``` cd test-server npm install @@ -16,10 +30,10 @@ npm run dev # localhost:3030 ``` -Run the curator extension: +## Run the curator extension ``` cd curator npm install npm run watch -npm run dev #in new terminal +npm run dev # in new terminal ``` diff --git a/docs/screenshots/curator-flow.svg b/docs/screenshots/curator-flow.svg new file mode 100644 index 0000000..79812e7 --- /dev/null +++ b/docs/screenshots/curator-flow.svg @@ -0,0 +1,27 @@ + + Curator flow from diff capture to reviewer guidance + + + Curator Flow + From GitHub diff → ML scores → reviewer guidance + + + Diff capture + Chrome extension + + + Token scoring + Algo server + + + Reviewer focus + VS Code + PR UI + + + + + + Reviewer outcome + Curator highlights risk, reasoning, and next steps inside the diff. + Teams stay fast without missing the scary parts. + diff --git a/docs/screenshots/curator-sidebar.svg b/docs/screenshots/curator-sidebar.svg new file mode 100644 index 0000000..725a0f4 --- /dev/null +++ b/docs/screenshots/curator-sidebar.svg @@ -0,0 +1,28 @@ + + Curator reviewer panel with highlighted diffs + + + + Curator Panel + + + Risky diff: auth.ts + Tokens flagged: 14 + + + UI review: nav.tsx + Tokens flagged: 6 + + + Security: db.ts + Tokens flagged: 9 + + + Selected diff summary + + + + + + Curator highlights sections that deserve deeper review. + diff --git a/docs/screenshots/heatmap-overlay.svg b/docs/screenshots/heatmap-overlay.svg new file mode 100644 index 0000000..edd78d2 --- /dev/null +++ b/docs/screenshots/heatmap-overlay.svg @@ -0,0 +1,34 @@ + + Token risk heatmap overlay on diff content + + + Curator Heatmap + Token risk overlay on diff content + + + for (const file of files) { + + + const score = model.rank(file.diff) + + + + const tokens = tokenize(file.diff) + + + + annotate(tokens, score) + + + + } + + + Legend + + Low risk + + Medium + + High + diff --git a/docs/screenshots/pr-run-curator.svg b/docs/screenshots/pr-run-curator.svg new file mode 100644 index 0000000..568d94e --- /dev/null +++ b/docs/screenshots/pr-run-curator.svg @@ -0,0 +1,26 @@ + + Run Curator button on a GitHub pull request + + + + GitHub PR • Add risk scoring + + Run Curator + + + app/handlers/review.ts + + - const riskScore = 0.42 + + const riskScore = 0.67 + + const rationale = summarize(diff) + + + app/ui/overview.tsx + + - <Badge>Manual review</Badge> + + <Badge variant="warning">Curator</Badge> + + + Curator prompts reviewers + right on the diff +