Repository navigation
docs: help readers understand crawlkit pull requests - #254
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: 72c428f3-73ce-4a4a-bab5-2daa7caf05df
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
|
Codex review: needs maintainer review before merge. What this changesThis PR adds crawlkit-specific examples and clearer writing guidance to the pull request template’s HTML comments. Example: An author describes a fix for refresh job names that resemble flags.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review This PR is a focused documentation improvement that is not on main. The examples match supported workflows, existing review guidance is preserved, and no actionable defects were found. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherGitHub presents the repository’s Markdown template to PR authors; its comments guide authoring while the four headings structure the published description. flowchart LR
A[Repository template] --> B[GitHub PR editor]
B --> C[Author reads guidance]
C --> D[PR description]
D --> E[Maintainer review]
Technical reviewBest possible solution: Land the focused template guidance while preserving its existing sections and substantive review requirements. Do we have a high-confidence way to reproduce the issue? No runtime bug is claimed; source inspection confirms the writing examples describe supported crawlkit workflows. Is this the best way to solve the issue? Editing the existing template comments is a small, appropriate way to improve descriptions without adding sections, checks, or runtime machinery. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against b9fbd520a505. Provenance checked
SecurityNone. EvidenceWhat I checked:
Likely related people:
Preflight sourceSource unknown. Source comparison at the observed PR snapshot only. Completion is self-reported; body, policy, tests, execution, and report bytes are not verified. LabelsLabel changes:
Label justifications:
Rating scale6/6 🦀 challenger crab · 5/6 🦞 diamond lobster · 4/6 🐚 platinum hermit · 3/6 🦐 gold shrimp · 2/6 🦪 silver shellfish · 1/6 🧂 unranked krab. Overall follows the weaker of proof and patch quality; ✨ marks media proof (a screenshot, video, or linked artifact) that directly shows the changed behavior. WorkflowClawSweeper edits this one comment on every review. Comment Reviewed November 16, 2026, 9:12 PM ET / November 17, 2026, 02:12 UTC. |
What Problem This Solves
A crawlkit PR can describe parser or database internals without explaining what an operator or crawl-app developer is trying to do, what goes wrong, or why it matters. Readers then have to inspect the diff to understand its purpose.
User Impact
PR authors get crawlkit-specific examples of clear titles and problem statements, with validation summaries that explain the checked behavior and result before commands or logs. There is no runtime change and no new required section, checklist, test, or review gate.
Why This Change Was Made
Adapt the reader-first guidance to supported crawlkit workflows: running refresh jobs whose names resemble flags and stopping database-write waits at their deadline. For example, prefer “let crawlctl run jobs whose names look like flags” over “guard parsing after the argument separator.” These are writing examples, not new fixes in this PR.
Only HTML comments in
.github/pull_request_template.mdchange. Existing headings, visible template bytes, maintainer-edit guidance, risks and migration guidance, and the literal problem prompt remain unchanged.Evidence
Validation details
Reviewed base:
b9fbd520a50528d920b65fe35a6229d165ce4611.Reviewed candidate:
4c3a45c260eb3e09817815b23539bf487a599e38.Candidate tree:
513a0dae7c347b19e71bccb4312ae36f7bb039cb.GOWORK=off go vet ./...andGOWORK=off go test -count=1 ./...: passed with Go 1.27.4.make check: passed in a clean detached worktree of the same candidate, includinggo mod tidywith unchangedgo.mod/go.sum, formatting, vet, dead-code analysis,govulncheck(“No vulnerabilities found”), unit/race tests, and Node script tests (47 passed, 0 failed).git diff --checkand comment-preservation assertions: passed.Worked on by
Work sessions
Linked for team reference; these sessions aren’t public.