Skip to content

Commit a4e5b23

Browse files
committed
docs: update PR template review guidance
1 parent 9f03054 commit a4e5b23

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

.github/pull_request_template.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,18 @@ For bug fixes or regressions, name the smallest reliable test coverage that shou
6565
List user-visible changes (including defaults/config).
6666
If none, write `None`.
6767

68+
## Diagram (if applicable)
69+
70+
For UI changes or non-trivial logic flows, include a small ASCII diagram reviewers can scan quickly. Otherwise write `N/A`.
71+
72+
```text
73+
Before:
74+
[user action] -> [old state]
75+
76+
After:
77+
[user action] -> [new state] -> [result]
78+
```
79+
6880
## Security Impact (required)
6981

7082
- New permissions/capabilities? (`Yes/No`)
@@ -129,12 +141,6 @@ If a bot review conversation is addressed by this PR, resolve that conversation
129141
- Migration needed? (`Yes/No`)
130142
- If yes, exact upgrade steps:
131143

132-
## Failure Recovery (if this breaks)
133-
134-
- How to disable/revert this change quickly:
135-
- Files/config to restore:
136-
- Known bad symptoms reviewers should watch for:
137-
138144
## Risks and Mitigations
139145

140146
List only real risks for this PR. Add/remove entries as needed. If none, write `None`.

0 commit comments

Comments
 (0)