|
| 1 | +# Pull Requests |
| 2 | + |
| 3 | +Useful pull requests are not just code dumps. They explain the operational change clearly enough that reviewers, CI, and future agents can understand what changed and why. |
| 4 | + |
| 5 | +## What Good PRs Should Do |
| 6 | + |
| 7 | +- state the problem first |
| 8 | +- summarize the actual change in a short `Changes` section |
| 9 | +- keep the scope coherent instead of mixing unrelated work |
| 10 | +- include docs or examples when behavior or workflow changes |
| 11 | +- give reviewers enough runtime or config context to validate the change |
| 12 | + |
| 13 | +## Preferred Shape |
| 14 | + |
| 15 | +Use a structure like this: |
| 16 | + |
| 17 | +```md |
| 18 | +## Problem |
| 19 | + |
| 20 | +What is broken, drifting, risky, or unclear? |
| 21 | + |
| 22 | +## Changes |
| 23 | + |
| 24 | +- concrete change 1 |
| 25 | +- concrete change 2 |
| 26 | +- concrete change 3 |
| 27 | + |
| 28 | +## Validation |
| 29 | + |
| 30 | +- command or workflow used to verify |
| 31 | +- relevant environment or scenario notes |
| 32 | + |
| 33 | +## Related |
| 34 | + |
| 35 | +- issue, incident, or follow-up links |
| 36 | +``` |
| 37 | + |
| 38 | +If screenshots, logs, or runtime traces make the problem clearer, include them. Use them to support the explanation, not replace it. |
| 39 | + |
| 40 | +## What The Example PRs Do Well |
| 41 | + |
| 42 | +Reference examples: |
| 43 | + |
| 44 | +- `udx/worker-site#76` |
| 45 | +- `udx/worker#117` |
| 46 | +- `udx/worker#113` |
| 47 | + |
| 48 | +Patterns worth repeating from those PRs: |
| 49 | + |
| 50 | +- they explain the problem in operational terms, not only code terms |
| 51 | +- they keep the change list concrete and scannable |
| 52 | +- they connect config, runtime, and dependency updates instead of pretending the code changed in isolation |
| 53 | +- they include documentation updates when workflow or behavior changes |
| 54 | +- they show real scenarios or examples when precedence, secrets, or runtime behavior is subtle |
| 55 | + |
| 56 | +## PR Rules |
| 57 | + |
| 58 | +- keep one PR focused on one logical improvement area |
| 59 | +- if the change has multiple logical parts, use separate commits with clean commit subjects |
| 60 | +- include docs updates when the engineering contract changes |
| 61 | +- prefer reproducible validation over “tested locally” statements |
| 62 | +- do not hide important behavior changes inside dependency bump PRs without explaining the behavioral reason |
| 63 | + |
| 64 | +## Anti-Patterns |
| 65 | + |
| 66 | +- vague titles that do not describe the operational change |
| 67 | +- large mixed PRs with unrelated fixes |
| 68 | +- no explanation of config or runtime impact |
| 69 | +- no validation notes for behavior-sensitive changes |
| 70 | +- missing docs when commands, structure, or workflow expectations changed |
| 71 | + |
| 72 | +## How This Fits `dev.kit` |
| 73 | + |
| 74 | +`dev.kit` should eventually validate more of this automatically: |
| 75 | + |
| 76 | +- whether workflow-affecting changes also updated docs |
| 77 | +- whether architecture or config contracts changed without explanation |
| 78 | +- whether PR-sized changes stay aligned with the repo's engineering guide |
0 commit comments