|
Download .github/pull_request_template.md from SaylorTwift/openclaw: direct link, hf CLI and curl.
- Browser
- Download file 2.43 kB
-
https://huggingface.co/SaylorTwift/openclaw/resolve/main/.github/pull_request_template.md
- Command line
-
hf download hf://SaylorTwift/openclaw/.github/pull_request_template.md
-
curl -L -o pull_request_template.md https://huggingface.co/SaylorTwift/openclaw/resolve/main/.github/pull_request_template.md
2.43 kB
| <!-- | |
| Optional linked context: | |
| Add a visible `Closes #<issue-number>` or `Related: #<issue-number>` 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 | |
| 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 | |
| **MUST:** Keep **Allow edits from maintainers** enabled for this PR so maintainers | |
| can help update the branch when needed. | |
| --> | |
| ## What Problem This Solves | |
| <!-- | |
| Describe the concrete user, product, or operational problem. | |
| 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. | |
| --> | |
| ## User Impact | |
| <!-- | |
| "User impact: <what users, operators, or developers can now do or expect>." | |
| 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. | |
| --> | |
| ## Why This Change Was Made | |
| <!-- | |
| Briefly explain how the change addresses the problem without repeating the impact. | |
| 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>. | |
| --> | |
| ## Evidence | |
| <!-- | |
| Show the most useful proof that this change works. Screenshots, screencasts, | |
| terminal output, focused tests, CI results, live observations, redacted logs, | |
| and artifact links are all useful. For user-visible UI changes, follow the root | |
| AGENTS.md "Product and validation" screenshot completion/landing gate; these other | |
| forms of evidence do not replace the required screenshots in chat AND the PR. | |
| 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. | |
| --> | |