Repository navigation
docs: clarify reader-first PR guidance for clawpatch - #261
Merged
Merged
Conversation
Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com>
Worked on by: - @hannesrudolph Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com> OpenClaw-Publication: 7ff1237c-959c-4828-a5d4-6ce87cdd7a19
Contributor
|
🦞👀 Pull request received. I will update this pull request when review starts. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Problem This Solves
Clawpatch contributors need examples and evidence guidance that explain a change without requiring readers to know the implementation.
User Impact
User impact: contributors get clawpatch-specific examples and clearer guidance for reporting observed results; there is no CLI behavior change.
Why This Change Was Made
The template already has a plain-language structure. This changes only its hidden guidance: illustrative review/provider examples, concrete mapping and patch-workflow outcomes, and result-first evidence summaries. All four visible headings, non-comment bytes, existing
Fixes:andUser impact:prompts, title types, risk guidance, and the Allow edits from maintainers requirement remain intact. No new review gates or runtime/dependency changes.Evidence
.github/pull_request_template.mdchanged; all 96 non-comment bytes, four headings, five comment pairs, and the existing local requirements are preserved.git diff --check,pnpm typecheck,pnpm lint,pnpm build,pnpm format:check, andpnpm exec oxfmt --check .github/pull_request_template.mdpassed.pnpm test: 976 passed, 2 skipped, 1 failed. The unchangedsrc/open-pr.test.tstest “times out a hung git push instead of blocking open-pr” exceeded its 15-second limit.pnpm test src/open-pr.test.tsreproduced that timeout (4 passed, 1 failed). This is not a green local test suite; no runtime/toolchain repair is included in this template-only change.7367b4cdd9ba4a6f1492e4db62b9f431a392810d. Examples were checked against README workflows. No visual UI changed.Requested by and co-authored with @hannesrudolph.
Work sessions
Linked for team reference; these sessions aren’t public.
Worked on by