Skip to content

Commit aef502c

Browse files
authored
Enhance PR template with changelog and impact details (flutter#177333)
Updated the pull request template to include a changelog description section and improved clarity on impact description. This came up after multiple release engineering rotations where I needed to ask full time maintinainters to rewrite their changelogs entries. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [ ] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing.
1 parent d1293ae commit aef502c

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

.github/PR_TEMPLATE/PULL_REQUEST_CP_TEMPLATE.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,26 @@ Please fill in the form below, and a flutter domain expert will evaluate this ch
44
### Issue Link:
55
What is the link to the issue this cherry-pick is addressing?
66

7-
< Replace with issue link here >
8-
9-
### Changelog Description:
10-
Explain this cherry pick in one line that is accessible to most Flutter developers. See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples
11-
12-
< Replace with changelog description here >
7+
https://github.com/flutter/flutter/issues/< Replace with issue link here >
138

149
### Impact Description:
15-
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)? Does it impact development (ex. flutter doctor crashes when Android Studio is installed), or the shipping production app (the app crashes on launch)
10+
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)?
11+
Does it impact development (ex. flutter doctor crashes when Android Studio is installed),
12+
or the shipping of production apps (the app crashes on launch).
13+
This information is for domain experts and release engineers to understand the consequences of saying yes or no to the cherry pick.
1614

1715
< Replace with impact description here >
1816

17+
### Changelog Description:
18+
Explain this cherry pick:
19+
* In one line that is accessible to most Flutter developers.
20+
* That describes the state prior to the fix.
21+
* That includes which platforms are impacted.
22+
See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples.
23+
24+
< Replace with changelog description here >
25+
[flutter/<ISSUE_NUMBER>] When <SCENARIO> [on <PLAFORMS(S)>], <DESCRIPTION>
26+
1927
### Workaround:
2028
Is there a workaround for this issue?
2129

0 commit comments

Comments
 (0)