Skip to content

docs: the code review standard - #22

Merged
HackTuah merged 3 commits into
mainfrom
docs/code-review-standards
Oct 6, 2026
Merged

HackTuah merged 3 commits into
mainfrom
docs/code-review-standards

Conversation

@HackTuah

@HackTuah HackTuah commented Oct 6, 2026

Copy link
Copy Markdown
Member

What

docs/CODE_REVIEW.md: how a pull request is reviewed and what it needs before it merges. This is for OpenSSF gold code_review_standards (Met with this PR).

  • How: CI's required checks pass first, then a reviewer who isn't the author reads the whole diff and approves or requests changes line by line, and every review thread is resolved (the ruleset enforces this) before a merge commit.
  • Honest about today: while there are few maintainers, the lead may merge their own change after CI. The aim is a second person's review on every change.
  • What the reviewer checks:
    • it does what it says and matches its spec;
    • tests, with a regression test for each fix, and the coverage gates;
    • trust boundaries, input validation, no HTML from data, the privacy inventory and the assurance case;
    • dependencies within the license rule and the dependency policy;
    • no English or single-language assumptions, accessibility, and the popup budgets;
    • docs, the CHANGELOG and the DCO.
  • Standard of evidence: every claim carries a failing test or a command with its output.
  • Agent changes are reviewed the same way, and the lead agent re-verifies before opening a PR.

CONTRIBUTING.md now links it.

Checked

bestpractices-links --check (209 valid), check-old-name, check-base-neutral. Every path the document names exists.

🤖 Generated with Claude Code

docs/CODE_REVIEW.md says how a pull request is reviewed and what it needs
to merge: CI's required checks first, a reviewer who isn't the author,
every thread resolved, and a checklist of what must be true (spec and
tests, trust boundaries, input validation, privacy inventory,
dependencies, every-language and accessibility rules, size budgets,
docs, DCO), plus the standard of evidence for claims. It also says
plainly that the lead maintainer may still merge their own change after
CI while there are few maintainers. CONTRIBUTING.md links it.

This makes the OpenSSF gold criterion code_review_standards Met.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Ayla Croft <dev@scriptkittyos.com>
@HackTuah
HackTuah requested a review from minitru as a code owner October 6, 2026 21:28
HackTuah pushed a commit that referenced this pull request Oct 6, 2026
The secrets job checks out with fetch-depth 0, which fetches every
branch, and ran gitleaks with --log-opts=--all. So a finding on one
pull request's branch failed every other pull request (#22 failed on a
test key in #21's branch). It now scans HEAD: the whole history of main
plus the pull request's own commits, which is everything that would
land.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Ayla Croft <dev@scriptkittyos.com>
Ayla Croft and others added 2 commits October 6, 2026 17:52
Silver was earned on 2026-10-06, so the gold prerequisite is Met. The
page would otherwise have set it back to Unmet.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Ayla Croft <dev@scriptkittyos.com>
@HackTuah
HackTuah merged commit bec9165 into main Oct 6, 2026
14 checks passed
@HackTuah
HackTuah deleted the docs/code-review-standards branch October 6, 2026 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant