Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ fix(auth): login redirect loops when session cookie is expired

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: new channel messages are missing after reconnecting
Avoid implementation details such as:
fix: add null check to task query
fix: reset the event cursor on reconnect

Write for a reader who does not know ClickClack's implementation. Start with
the affected person and workflow, not a filename, helper, or internal acronym.
Use concrete language instead of vague claims like "improves reliability".
-->

<details>
Expand All @@ -31,6 +35,8 @@ Use one short, plain-language sentence. For fixes, prefer:
"Fixes: <what goes wrong> when <trigger or condition>."
For other changes, describe the need without inventing a bug.
Name the affected workflow, not the code-level cause.
For example: "Fixes: people miss new channel messages when their connection
drops and reconnects." Examples here are illustrative, not claims of existing bugs.
-->

## User Impact
Expand All @@ -40,6 +46,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 the reconnect example: "User impact: people can catch up on channel messages
after reconnecting without refreshing the page."
-->

## Why This Change Was Made
Expand All @@ -49,6 +57,8 @@ Briefly explain how the change addresses the problem without repeating the impac
Keep the body short. Leave file lists, internal acronyms, and root-cause walkthroughs
in the diff or optional <details>; include technical detail only when it explains
behavior or a material tradeoff. Do not hide risks or required actions in <details>.
Explain why the approach helps the affected workflow; a list of changed files
or functions is not a substitute.
-->

## Evidence
Expand All @@ -63,4 +73,9 @@ 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 <details>, keeping the useful evidence summary visible.
Lead with the observed outcome, not just a list of commands or test names.
For example, only if verified: "After reconnecting the web client, messages sent
while offline appeared once and in order. The focused reconnect test passed;
desktop reconnect behavior was not checked." Distinguish observed behavior from
what a test covers, and state failures or untested paths rather than implying success.
-->
Loading