From f806162ccf4c8c6156d582b0363ec26ce6c14177 Mon Sep 17 00:00:00 2001 From: roboclaw-bot <309084314+roboclaw-bot@users.noreply.github.com> Date: Tue, 17 Nov 2026 04:32:16 +0000 Subject: [PATCH 1/2] docs: clarify reader-first PR guidance for clawpatch Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com> --- .github/pull_request_template.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 307a73b6..a4e028d8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,13 +6,13 @@ below this comment. Required PR title: type: user-facing description Use a parenthesized scope only when it adds clarity: -fix(auth): login redirect loops when session cookie is expired +fix(provider): review fails when the repository path contains spaces Types: feat, fix, improve, refactor, docs, chore. For fixes, describe the user-visible symptom and trigger: -fix: task list fails to load when user has no environments +fix: review cannot resume after an interrupted run Avoid implementation details such as: -fix: add null check to task query +fix: add null check to run record **MUST:** Keep **Allow edits from maintainers** enabled for this PR so maintainers can help update the branch when needed. @@ -25,7 +25,9 @@ Describe the concrete user, product, or operational problem. Use one short, plain-language sentence. For fixes, prefer: "Fixes: when ." For other changes, describe the need without inventing a bug. -Name the affected workflow, not the code-level cause. +Name the affected workflow, not the code-level cause. A reader should understand +the problem without knowing clawpatch internals. The title examples above are +illustrative, not claims about current bugs. --> ## User Impact @@ -35,6 +37,8 @@ Name the affected workflow, not the code-level cause. Lead with the concrete outcome in plain language, usually one sentence. For internal-only changes, say there is no user-visible change; do not invent a benefit. Keep important risks, breaking changes, migrations, and required user actions visible here. +For example, describe whether maintainers can map a project, resume a review, +validate a finding, or open a patch PR; use only the outcome this change delivers. --> ## Why This Change Was Made @@ -56,6 +60,12 @@ changes when it clarifies the result. Reviewers will inspect the code, tests, and CI. Use this section to make the validation easy to understand, not to restate the diff. -Summarize what was checked and the result; note meaningful gaps. Link long output -or put it in optional
, keeping the useful evidence summary visible. +Summarize what was checked and the result; note meaningful gaps. Start with the +observed outcome, not just a command list or a claim that tests passed. For a +mapping change, say which project shape was checked and whether the expected +feature slices appeared. For a review or patching change, describe the exercised +workflow and its result. Include the exact checks run, and distinguish passed, +failed, and untested behavior; do not imply broader coverage than the evidence. +Link long output or put it in optional
, keeping the useful evidence +summary visible. --> From c7fc5ee7a5488a2e134d75272a3a3a7cc962aa62 Mon Sep 17 00:00:00 2001 From: roboclaw-bot <309084314+roboclaw-bot@users.noreply.github.com> Date: Tue, 17 Nov 2026 04:32:23 +0000 Subject: [PATCH 2/2] docs: clarify reader-first PR guidance for clawpatch Worked on by: - @hannesrudolph Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com> OpenClaw-Publication: 7ff1237c-959c-4828-a5d4-6ce87cdd7a19