From 00669cc604184f44be6203fcf019d497b4ccc8af Mon Sep 17 00:00:00 2001 From: "Kit (OpenClaw)" Date: Tue, 17 Mar 2026 14:18:50 -0400 Subject: [PATCH] docs: add PR body requirements section to CONTRIBUTING.md Fixes #924 Document the required 'Client impact' and 'Verification Plan' sections that every pull request body must include, with a minimal format example. --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60990f781..38ea58f03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -147,6 +147,36 @@ Rails or Ruby upgrade. a comment explaining the blocker and a link to the tracking issue. 3. Never ignore a CVE silently — always add a justification comment. +#### Pull Request Body Requirements + +Every pull request must include the following two sections in its body: + +**Client impact** — Describe how this change affects end users, store operators, or +system integrators. If there is no user-visible effect, write "None" with a brief +explanation (e.g. "None (docs only)." or "None (internal refactor)."). + +**Verification Plan** — Describe the steps a reviewer can follow to confirm the +change works as intended. For automated changes this may reference the test suite; +for UI changes it should include manual steps. + +Minimal example: + +```markdown +## Client impact + +Brief description of how clients / end users are affected, or "None" if not applicable. + +## Verification Plan + +1. Run `bin/rails test test/path/to/relevant_test.rb` +2. Visit /some-path and confirm the expected behaviour. +``` + +PRs that are missing either section may be closed without review until the body is +updated. + +--- + Thanks! The Workarea Core Team