docs: ARCHITECTURE map + contributor guide (GitHub Flow) - #13
Conversation
Make the repo easy to contribute to and obvious where to code. - ARCHITECTURE.md: one-diagram overview of the deterministic core + three surfaces, the public/private boundary, an internal/ package tour, the governed-call request flow, and a "where do I code?" table. - CONTRIBUTING.md: dev setup (make targets), the GitHub Flow PR process (fork -> branch off main -> PR; build & test + CodeQL required + review), conventional commits, the trust rules (internal/ boundary, deterministic enforcement, no-telemetry egress incl. the approval webhook, honesty), and a pre-PR checklist. - README: a Contributing section linking both + good-first-issue + CoC.
|
Claude finished @prashar32's task in 1m 57s —— View job PR Review
Overall this is a high-quality documentation PR. The content is accurate, the structure is clear, and all cross-references are valid. A few observations: ARCHITECTURE.mdStrengths:
Minor nit — ASCII diagram right border: The ...or placing the outbound arrow clearly outside the closing Minor nit — "I want to…" is a bullet list, not a table: CONTRIBUTING.mdStrengths:
Suggestion — fork vs. direct branch: Suggestion — make build # produces ./riskkernel at the repo root
./riskkernel serveREADME.mdStrengths:
No issues. SummaryThis PR is ready to merge with the ASCII diagram nit and the fork-vs-branch clarification being the only actionable items. Everything else is accurate, complete, and consistent with the actual codebase structure and Makefile. |
Makes the repo contributor-friendly and obvious where to code, and documents the GitHub Flow model (single
main; fork → branch → PR tomain;build & test+CodeQL+ maintainer review gate every merge).ARCHITECTURE.md(new) — one-diagram overview (deterministic core + three surfaces), the public/private boundary, aninternal/package tour, the governed-call request flow, and an "I want to… — where do I code?" table.CONTRIBUTING.md(expanded) — dev setup (maketargets), the PR flow, conventional commits, the trust rules (internal boundary, deterministic-only enforcement, no-telemetry egress incl. the approval webhook, honesty), and a pre-PR checklist.README.md— a Contributing section linking both + good-first-issue + Code of Conduct.No code or branch/ruleset changes —
mainis already set up for GitHub Flow.