chore(governance): PR template with Red-then-green DoD (G-1) - #1349
chore(governance): PR template with Red-then-green DoD (G-1)#1349SharedQA wants to merge 5 commits into
Conversation
Shifts the test/quality declaration onto the author per the stabilization plan (G-1). Checklist is drawn from the recurring silent-failure classes: connector->silver reach, gold-view resolution, enforced dbt contracts (type drift), golden-value parity, non-nullable dedup keys (constructorfabric#1330), honest NULLs and the UI render contract / error-vs-empty (constructorfabric#1336/constructorfabric#1337). Red-then-green is the top rule: a fix ships with a test that failed before it. Signed-off-by: Kenan Salim <kenan.salim@rolos.com>
|
Warning Review limit reached
More reviews will be available in 56 minutes and 32 seconds. Learn how PR review limits work. To continue reviewing without waiting, enable usage-based billing in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA new ChangesPull Request Template
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
.github/PULL_REQUEST_TEMPLATE.md (2)
15-15: 💤 Low valueDefine "the ratchet" jargon.
Line 15 uses the term "the ratchet" without explanation. While context suggests it refers to coverage ratcheting (fail if coverage falls below the base branch), this terminology is not explicitly defined. New contributors may not recognize the term.
Consider adding a brief clarification, e.g.,
Coverage held or raised vs the base branch (**ratchet**: fail if coverage drops).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/PULL_REQUEST_TEMPLATE.md at line 15, The checkbox item on line 15 of the PULL_REQUEST_TEMPLATE.md uses the term "the ratchet" without explanation, which may confuse new contributors unfamiliar with the terminology. Add a brief clarification immediately after or adjacent to "the ratchet" to explain that it refers to the coverage ratcheting mechanism that fails if coverage drops below the base branch level. For example, you can add inline parenthetical text like "(ratchet: fail if coverage drops)" or similar wording to make the term explicit and self-documenting.
14-14: 💤 Low valueClarify what
make checkincludes.Line 14 invokes
make checkas a gating criterion but does not define which checks/gates are included (fmt, lint, typecheck, tests, etc.). New contributors may not know what this target does or whether it exists in their environment.Consider either:
- Documenting
make checkin the repository root (Makefile, README, or CONTRIBUTING guide), or- Expanding the comment inline to enumerate the gates (e.g.,
make check (lint · type · test · gates)with a link to the actual target).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/PULL_REQUEST_TEMPLATE.md at line 14, The pull request template at line 14 references `make check` without explaining what checks it includes, which may confuse new contributors. Update the inline comment on that line to explicitly enumerate the checks that `make check` performs (such as fmt, lint, typecheck, tests, and relevant gates), making it clear what verification steps are required before pushing. Additionally, consider adding documentation for the `make check` target in the Makefile, README, or CONTRIBUTING guide to provide full context about what this command does and ensure contributors can easily understand and run it in their environment.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 15: The checkbox item on line 15 of the PULL_REQUEST_TEMPLATE.md uses the
term "the ratchet" without explanation, which may confuse new contributors
unfamiliar with the terminology. Add a brief clarification immediately after or
adjacent to "the ratchet" to explain that it refers to the coverage ratcheting
mechanism that fails if coverage drops below the base branch level. For example,
you can add inline parenthetical text like "(ratchet: fail if coverage drops)"
or similar wording to make the term explicit and self-documenting.
- Line 14: The pull request template at line 14 references `make check` without
explaining what checks it includes, which may confuse new contributors. Update
the inline comment on that line to explicitly enumerate the checks that `make
check` performs (such as fmt, lint, typecheck, tests, and relevant gates),
making it clear what verification steps are required before pushing.
Additionally, consider adding documentation for the `make check` target in the
Makefile, README, or CONTRIBUTING guide to provide full context about what this
command does and ensure contributors can easily understand and run it in their
environment.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 0b95fc7e-ce34-47df-a3e0-885c250d8697
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md
Review feedback on constructorfabric#1349: - cyberantonz: there is no `make check` target in the repo, so the DoD line referenced a command that does not exist. Replace it with the actual local checks (cargo fmt/clippy/test for Rust, pnpm typecheck/test for frontend, cpt validate for docs). - CodeRabbit nitpick: spell out "the ratchet" inline (CI fails if coverage drops below the base branch). Signed-off-by: Kenan Salim <kenan.salim@rolos.com>
Review feedback on constructorfabric#1349 (cyberantonz): this repo has no frontend — the React SPA is the separate insight-front repo. So: - drop the `pnpm` frontend commands from the local-checks line (keep Rust + .NET + cpt validate) - rename "API / Frontend (UI)" to "API (serving layer)" and remove the render-contract / Vitest / Playwright items; those belong in the insight-front PR template. Keep the API-side items (honest NULLs, error vs empty). Signed-off-by: Kenan Salim <kenan.salim@rolos.com>
Adds
.github/PULL_REQUEST_TEMPLATE.md— the author-facing Definition of Done from the stabilization plan (task G-1).Red-then-green is the headline rule: a fix lands with a test that failed before it and passes after, with the expected value derived from the spec (not current output).
The Data and UI checklists are pulled straight from the bug classes that recurred: connector→silver reach (#1319/#1334), gold-view resolution (#1330), enforced dbt contracts / type drift (#1318/#1323), golden-value parity (#1324), non-nullable dedup keys (#1330/#1348), honest NULLs + render-contract error-vs-empty (#1336/#1337).
Moves QA from chasing people to GitHub asking the author to declare it — the next step is CI mechanically confirming each promise.
Summary by CodeRabbit