diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 307a73b..d5029a3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,16 +3,21 @@ Optional linked context: Add a visible `Closes #` or `Related: #` line 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 +Write for someone who uses or builds crawl apps but has not read the code. The +title and opening problem statement should make sense without the diff or linked issue. +Required PR title: +type: 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 -Avoid implementation details such as: -fix: add null check to task query +Use a parenthesized scope only when it helps that reader. + +Name the affected task and the symptom or outcome, not the implementation: +Good: fix: let crawlctl run jobs whose names look like flags +Bad: fix(crawlctl): guard parsing after the argument separator +Good: fix: stop waiting for a database write when its deadline expires +Bad: fix(store): propagate context cancellation to the busy handler + +For internal-only work, name the actual developer or operator workflow affected. **MUST:** Keep **Allow edits from maintainers** enabled for this PR so maintainers can help update the branch when needed. @@ -22,10 +27,16 @@ can help update the branch when needed. ## User Impact @@ -54,8 +65,8 @@ terminal output, focused tests, CI results, live observations, redacted logs, and artifact links are all useful. Include before/after evidence for visual 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. +Start with the behavior checked and the result in plain language. Reviewers will +inspect the code, tests, and CI; do not make them decode command lists to learn +what was verified. Put exact commands, commit hashes, and long output in links +or optional
. Keep the useful evidence summary and meaningful gaps visible. -->