Repository navigation
docs: make PR template guidance reader-first - #165
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: f2bcbc3e-5356-4e2a-86b7-bc19fb6f5075
|
🦞👀 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.
Summary
Reviewers should understand the problem, task, or value of a terminal change before its implementation, and what validation established before a list of commands. Expand only the existing template's HTML comments with that ordering and paired, illustrative libterminal examples.
The original prompts, headings, checklists, compatibility/security guidance, and every byte outside HTML comments are unchanged. No new tests or contribution gates are introduced.
Compatibility And Security
No protocol, export, runtime, ordering, cancellation, or security behavior changes. This is PR-authoring guidance only; no dependency, toolchain, workflow execution, or release changes.
Validation
Preservation checks pass: all noncomment bytes match the original template, all three original prompts remain, comments are balanced, and the diff contains only
.github/PULL_REQUEST_TEMPLATE.md.git diff --checkpasses.Independent shared autoreview at P0–P3 is
scoped-clean, with no actionable findings:python3 "$HOME/.agents/skills/autoreview/scripts/autoreview" --max-priority P3 --mode localwith task-specific preservation context.Formatting, build, portable/type checks, and lint pass.
pnpm checkthen reports 184 passing and 9 failing tests: all failures are five-second timeouts intest/hub-close.test.tsnative WebSocket teardown cases. A separate minimal native-WebSocket loopback probe errors before opening, without importing libterminal. This records a local validation limitation, not a green full check or a gate waiver.Package checks pass separately via
pnpm run pack:check; the originalpnpm checkstopped before that stage. Dependencies were installed withpnpm install --frozen-lockfileusing declared pnpm 11.28.6; validation used Node 26.12.1. No lockfile or dependency changes.Browser E2E/release checks were not run locally. Runtime source and tests are unchanged; hosted exact-head checks will be assessed before landing.
Tests added or updated when behavior changed
Browser, Node.js, and Worker impact considered
CHANGELOG.mdupdated when user-visible or compatibility-relevantNo credentials, private paths, private hosts, or sensitive logs included
The conditional test/changelog items are not applicable: this change affects only hidden PR-template guidance, not package behavior or compatibility.
Requested by and implemented with Hannes (@hannesrudolph).
Work sessions
Linked for team reference; these sessions aren’t public.
Worked on by