Skip to content

Expand CONTRIBUTING guidelines and audit them in the review skill#4493

Merged
twmb merged 2 commits into
mainfrom
contributing-and-review-skill
Jun 12, 2026
Merged

Expand CONTRIBUTING guidelines and audit them in the review skill#4493
twmb merged 2 commits into
mainfrom
contributing-and-review-skill

Conversation

@twmb

@twmb twmb commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

What

Extends the connector certification & contribution guidelines and wires the /review skill to enforce them.

CONTRIBUTING.md

  • §1.3.4 — benchmarking phases: make explicit that benchmarking has two required phases — local/localhost (unit + local integration) and real-endpoint (against a real deployed server). Points at docs/benchmarking.md for the standard process and docs/benchmark-results/ for recording results.
  • §3.1.2 / §3.1.3 — Go-first: require gofumpt formatting, and add a rule that connectors are idiomatic Go built toward a goal — supporting the target endpoint well, where "well" is defined by the rest of the document (UX, configuration knobs/validation, observability, reliability). A reference implementation (e.g. Debezium for CDC) may be consulted to understand the endpoint, but it is not a spec to replicate and we are not bound to its abstractions, idioms, or naming — never a line-by-line port.
  • §3.3 — change size: keep commits/PRs reviewable with a ~10K-line guideline on code a reviewer must read — AI-generated code included (it needs more review, not less). Only content not reviewed line-by-line is excluded: generated/derived files, vendored code, lockfiles, and non-code (docs, skills, Terraform, templates, fixtures). Large features should be split into smaller, independently reviewable PRs.

.claude/skills/review/SKILL.md

  • Loads CONTRIBUTING.md into review context (applies to internal and external contributions).
  • New Certification & Contribution Guidelines agent audits the entire document, delegating section ownership to the existing specialist agents (Go-first → godev, tests → tester, benchmarking → benchmarking agent, change size → commit policy) so there's no duplicate flagging.
  • Teaches godev to flag §3.1.3 foreign ports and the commit-policy agent to flag the §3.3 size guideline — counting code a reviewer must read (incl. AI-generated), and skipping generated/non-code-heavy PRs.
  • Widens the filter to allow CONTRIBUTING.md findings across all sections, with guardrails: subjective criteria (UX/doc polish) only on a clear, material gap with diff evidence; §2 selection criteria as non-blocking notes.

Why

Codifies internal contribution standards and makes review enforce them automatically for both internal and external contributors.

Scope note

Benchmarking infrastructure harmonization (reconciling docs/benchmarking.md with the in-flight AWS bench framework in #4487, and teaching the review skill about benchmarking/aws/) is intentionally out of scope here — that's left to the benchmarking work in #4487.

🤖 Generated with Claude Code

@twmb twmb force-pushed the contributing-and-review-skill branch 2 times, most recently from 2f61530 to 0f3c0d4 Compare June 10, 2026 06:17
twmb and others added 2 commits June 10, 2026 00:18
…nd PR size limit

- §1.3.4: split benchmarking into two required phases (local/localhost and
  real-endpoint), pointing at docs/benchmarking.md for the standard process and
  docs/benchmark-results/ for recording results.
- §3.1.2/§3.1.3: require gofumpt formatting and add a Go-first rule — connectors
  are idiomatic Go built to support their endpoint well (per the rest of this
  document), never a line-by-line port of another ecosystem's implementation
  (e.g. Debezium for CDC).
- §3.3: add a contribution-process section keeping commits/PRs reviewable, with
  a ~10K-line guideline on code a reviewer must read (AI-generated code included);
  excludes generated/derived files, vendored code, and non-code (docs, skills,
  Terraform); large features split into smaller PRs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a Certification & Contribution Guidelines agent that walks all of
CONTRIBUTING.md and delegates section ownership to the existing specialist
agents (Go-first -> godev, tests -> tester, benchmarking -> benchmarking agent,
change size -> commit policy) to avoid duplicate findings. Load CONTRIBUTING.md
into review context, teach godev to flag §3.1.3 foreign ports and commit policy
to flag the §3.3 size guideline (counting code a reviewer must read, including
AI-generated, and skipping generated/non-code-heavy PRs), and widen the filter
to allow CONTRIBUTING.md findings across all sections (subjective criteria only
on a clear, material gap; §2 selection criteria as non-blocking notes).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@twmb twmb force-pushed the contributing-and-review-skill branch from 0f3c0d4 to edda777 Compare June 10, 2026 06:18
@twmb twmb merged commit 9f8f994 into main Jun 12, 2026
7 of 8 checks passed
@twmb twmb deleted the contributing-and-review-skill branch June 12, 2026 17:49
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.

2 participants