Skip to content

Commit 543a7f5

Browse files
committed
tighten pull request guidance
1 parent 3172449 commit 543a7f5

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/pull-requests.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Useful pull requests are not just code dumps. They explain the operational chang
77
- state the problem first
88
- summarize the actual change in a short `Changes` section
99
- keep the scope coherent instead of mixing unrelated work
10+
- start from a branch that is reasonably fresh against the target base branch
1011
- include docs or examples when behavior or workflow changes
1112
- give reviewers enough runtime or config context to validate the change
1213

@@ -56,11 +57,23 @@ Patterns worth repeating from those PRs:
5657
## PR Rules
5758

5859
- keep one PR focused on one logical improvement area
60+
- do not open a PR from a long-lived catch-all branch if the work can still be split or rebased cleanly
5961
- if the change has multiple logical parts, use separate commits with clean commit subjects
6062
- include docs updates when the engineering contract changes
6163
- prefer reproducible validation over “tested locally” statements
6264
- do not hide important behavior changes inside dependency bump PRs without explaining the behavioral reason
6365

66+
## Branch Hygiene
67+
68+
PR quality starts before the PR body is written.
69+
70+
- sync with the target base branch before starting or resuming work
71+
- avoid stacking unrelated work on one long-lived branch
72+
- if the branch already accumulated mixed history, split it before review when practical
73+
- if splitting is not practical, be explicit in the PR body that the PR is cumulative and group the changes honestly
74+
75+
A good PR body cannot rescue a bad branch shape. It can only make the review less painful.
76+
6477
## Anti-Patterns
6578

6679
- vague titles that do not describe the operational change

0 commit comments

Comments
 (0)