Skip to content

Commit 09b7a1c

Browse files
authored
[github actions] rewrite cherry pick template (#144065)
Context: @godofredoc pointed out that the fields in the PR template could be simplified and redesigned. Synced with @itsjustkevin and Kevin come up with [changes in this doc](https://docs.google.com/document/d/1Slppqq32toSwwxUyYTX1t6dGUQpyi0xEWxw4niGWspc/edit?resourcekey=0-v6U_9XVsMFSx0Fvx1rANhg&tab=t.0) which would improve the cherry pick template. Github only supports a limited number of formatting options. This PR uses some workarounds and makes the following changes: 1. use divider to replace text area since Github markdown doesn't support text area 2. remove \<pre\> tags so texts can wrap around 3. use headings over bold 4. use task lists to identify the starting points of user answers An example cherry pick template would [look like this](flutter/flutter#143785) after the change.
1 parent 18712ed commit 09b7a1c

File tree

1 file changed

+21
-54
lines changed

1 file changed

+21
-54
lines changed
Lines changed: 21 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,40 @@
1-
**This pull request is opened against a release branch.<br>
2-
To request a cherry pick of a commit, please fill in the form below.** (Questions with an asterisk are required.)<br>
1+
This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/wiki/Flutter-Cherrypick-Process#automatically-creates-a-cherry-pick-request)
2+
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.
33

4-
**To fill in the form, you can edit this PR description and type your answers after the 'My Answer' keywords. <br>
5-
A flutter domain expert will evaluate this cherry pick request shortly after ALL questions are answered.**
4+
### Issue Link:
5+
What is the link to the issue this cherry-pick is addressing?
66

7-
* Issue Link: What is the link to the issue this cherry-pick is addressing?<br>
7+
< Replace with issue link here >
88

9-
<pre>
10-
<b>My Answer:</b>
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/wiki/Hotfix-Documentation-Best-Practices) for examples
1111

12+
< Replace with changelog description here >
1213

13-
</pre>
14+
### 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)
1416

15-
* Changelog Description: Explain this cherry pick in one line that is accessible to most Flutter developers
16-
See https://github.com/flutter/flutter/wiki/Hotfix-Documentation-Best-Practices for examples (Bug fix, feature, docs update, ...)<br>
17+
< Replace with impact description here >
1718

18-
<pre>
19-
<b>My Answer:</b>
19+
### Workaround:
20+
Is there a workaround for this issue?
2021

22+
< Replace with workaround here >
2123

22-
</pre>
24+
### Risk:
25+
What is the risk level of this cherry-pick?
2326

24-
* Impacted Users: Approximately who will hit this issue (ex. all Flutter devs, Windows developers, all end-customers, apps using X framework feature)?<br>
25-
26-
<pre>
27-
<b>My Answer:</b>
28-
29-
30-
</pre>
31-
32-
* impact_description: 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)<br>
33-
34-
<pre>
35-
<b>My Answer:</b>
36-
37-
38-
</pre>
39-
40-
* Workaround: Is there a workaround for this issue?<br>
41-
42-
<pre>
43-
<b>My Answer:</b>
44-
45-
46-
</pre>
47-
48-
* Risk: What is the risk level of this cherry-pick?<br>
49-
50-
<pre>
51-
<b>My Answer:</b>
5227
- [ ] Low
5328
- [ ] Medium
5429
- [ ] High
5530

56-
</pre>
31+
### Test Coverage:
32+
Are you confident that your fix is well-tested by automated tests?
5733

58-
* Test Coverage: Are you confident that your fix is well-tested by automated tests?<br>
59-
60-
<pre>
61-
<b>My Answer:</b>
6234
- [ ] Yes
6335
- [ ] No
6436

65-
</pre>
66-
67-
* Validation Steps: What are the steps to validate that this fix works?<br>
68-
69-
<pre>
70-
<b>My Answer:</b>
71-
37+
### Validation Steps:
38+
What are the steps to validate that this fix works?
7239

73-
</pre>
40+
< Replace with validation steps here >

0 commit comments

Comments
 (0)