-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Enhance PR template with changelog and impact details #177333
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhance PR template with changelog and impact details #177333
Conversation
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request enhances the PR template for cherry-picks by adding a changelog description section with specific guidelines and improving the clarity of the impact description. This aims to standardize the information provided in cherry-pick requests, ensuring that release engineers and domain experts have the necessary context to make informed decisions. The changes primarily involve modifications to the PULL_REQUEST_CP_TEMPLATE.md file, focusing on the 'Impact Description' and 'Changelog Description' sections.
Corrected a typo in the impact description section.
justinmc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍 . Thanks for clarifying this, I've seen changelog descriptions be a sticking point several times now (at least one of those being from my own poor 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) | ||
| 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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit, I know you didn't write this:
"or the shipping production app" => "or the shipping of production apps"
I think that is more the intention?
| Explain this cherry pick: | ||
| * In one line that is accessible to most Flutter developers. | ||
| * That describes the state prior to the fix. | ||
| * That includes what platforms are impacted. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super nit: "what" => "which"
|
Reason for revert: Possibly broke the tree see #177465 |
This reverts commit aef502c.
…)" (#177468) <!-- start_original_pr_link --> Reverts: #177333 <!-- end_original_pr_link --> <!-- start_initiating_author --> Initiated by: reidbaker <!-- end_initiating_author --> <!-- start_revert_reason --> Reason for reverting: Possibly broke the tree see #177465 <!-- end_revert_reason --> <!-- start_original_pr_author --> Original PR Author: reidbaker <!-- end_original_pr_author --> <!-- start_reviewers --> Reviewed By: {justinmc} <!-- end_reviewers --> <!-- start_revert_body --> This change reverts the following previous change: 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. <!-- end_revert_body --> Co-authored-by: auto-submit[bot] <[email protected]>
…ls (#177333)" (#177468)" (#177499) <!-- start_original_pr_link --> Reverts: #177468 <!-- end_original_pr_link --> <!-- start_initiating_author --> Initiated by: reidbaker <!-- end_initiating_author --> <!-- start_revert_reason --> Reason for reverting: did not break tree see #177472 <!-- end_revert_reason --> <!-- start_original_pr_author --> Original PR Author: auto-submit[bot] <!-- end_original_pr_author --> <!-- start_reviewers --> Reviewed By: {fluttergithubbot} <!-- end_reviewers --> <!-- start_revert_body --> This change reverts the following previous change: <!-- start_original_pr_link --> Reverts: #177333 <!-- end_original_pr_link --> <!-- start_initiating_author --> Initiated by: reidbaker <!-- end_initiating_author --> <!-- start_revert_reason --> Reason for reverting: Possibly broke the tree see #177465 <!-- end_revert_reason --> <!-- start_original_pr_author --> Original PR Author: reidbaker <!-- end_original_pr_author --> <!-- start_reviewers --> Reviewed By: {justinmc} <!-- end_reviewers --> <!-- start_revert_body --> This change reverts the following previous change: 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. <!-- end_revert_body --> <!-- end_revert_body --> Co-authored-by: auto-submit[bot] <[email protected]>
Roll Flutter from 75004a639ae4 to cb18290fa45e (48 revisions) flutter/flutter@75004a6...cb18290 2025-10-24 [email protected] Remove unnecessary `deprecated` withOpacity in `text_button.0.dart` in examples (flutter/flutter#177374) 2025-10-24 [email protected] Roll Packages from 9ec29b6 to 53d6138 (3 revisions) (flutter/flutter#177502) 2025-10-24 [email protected] Roll Dart SDK from d3248b00f545 to a0480f399f8f (1 revision) (flutter/flutter#177498) 2025-10-24 [email protected] Roll Skia from a47931d09585 to 3ed332b77bec (3 revisions) (flutter/flutter#177487) 2025-10-24 [email protected] Roll Abseil to Chromium's 5b92b04a2e (based on Abseil commit fc4481e968) (flutter/flutter#177059) 2025-10-24 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Reverts "Enhance PR template with changelog and impact details (#177333)" (#177468)" (flutter/flutter#177499) 2025-10-24 [email protected] Document DropdownMenu showTrailingIcon and decorationBuilder interaction (flutter/flutter#177488) 2025-10-24 [email protected] Roll Dart SDK from 4a65fb890852 to d3248b00f545 (1 revision) (flutter/flutter#177486) 2025-10-24 [email protected] Fix bottom sheet Semantics route label for mismatched platforms (flutter/flutter#177094) 2025-10-24 [email protected] Roll Skia from eba11de00d5b to a47931d09585 (5 revisions) (flutter/flutter#177481) 2025-10-24 [email protected] Fix Dialog Semantics label and flags for mismatched platforms (flutter/flutter#176781) 2025-10-24 [email protected] Fix drawer Semantics for mismatched platforms (flutter/flutter#177095) 2025-10-24 [email protected] Roll Dart SDK from f7751ccea102 to 4a65fb890852 (2 revisions) (flutter/flutter#177480) 2025-10-23 [email protected] Change the root path of the license crawl to engine/src (flutter/flutter#177352) 2025-10-23 [email protected] [Material] Change default mouse cursor of buttons to basic arrow instead of click (except on web) (flutter/flutter#171796) 2025-10-23 [email protected] [Desktop] Propagate SemanticsNode::identifier to AXPlatformNodeDelegate::AuthorUniqueId (flutter/flutter#175405) 2025-10-23 [email protected] Roll Skia from 59ef57f4104e to eba11de00d5b (5 revisions) (flutter/flutter#177461) 2025-10-23 [email protected] Roll customer tests (flutter/flutter#177409) 2025-10-23 [email protected] Update CHANGELOG 3.35.7 notes (flutter/flutter#177463) 2025-10-23 [email protected] Marks Mac module_uiscene_test_ios to be unflaky (flutter/flutter#177378) 2025-10-23 [email protected] Allow empty dart defines in `flutter assemble` (flutter/flutter#177198) 2025-10-23 [email protected] Roll Packages from d113bbc to 9ec29b6 (12 revisions) (flutter/flutter#177455) 2025-10-23 [email protected] Implements engine-side declarative pointer event handling for semantics. (flutter/flutter#176974) 2025-10-23 [email protected] Fix the platform name of the windowing_test target for macOS in ci.yaml (flutter/flutter#177472) 2025-10-23 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Enhance PR template with changelog and impact details (#177333)" (flutter/flutter#177468) 2025-10-23 [email protected] Change Flutter APIs to use spans (flutter/flutter#177272) 2025-10-23 [email protected] Roll Dart SDK from 020988602772 to f7751ccea102 (4 revisions) (flutter/flutter#177449) 2025-10-23 [email protected] [macOS] Implement regular window (flutter/flutter#176361) 2025-10-23 [email protected] Enhance PR template with changelog and impact details (flutter/flutter#177333) 2025-10-23 [email protected] Roll Skia from 6e6acf6644ef to 59ef57f4104e (2 revisions) (flutter/flutter#177436) 2025-10-23 [email protected] Add directional static members to AlignmentGeometry. (flutter/flutter#176571) 2025-10-23 [email protected] Roll ICU from 1b2e3e8a421e to ff35c4f9df23 (5 revisions) (flutter/flutter#177434) 2025-10-23 [email protected] Adds a new CI build for Linux host DDM-enabled artifacts (flutter/flutter#177252) 2025-10-23 [email protected] Roll Skia from 920cdcadd74c to 6e6acf6644ef (1 revision) (flutter/flutter#177432) 2025-10-23 [email protected] Roll Skia from 8cd449e4953b to 920cdcadd74c (6 revisions) (flutter/flutter#177426) 2025-10-23 [email protected] Added ahem license (flutter/flutter#177423) 2025-10-23 [email protected] Roll Dart SDK from 75f6ccb9bdc5 to 020988602772 (1 revision) (flutter/flutter#177421) 2025-10-23 [email protected] [web] Set `pointer-events: none` for img-element-backed images (flutter/flutter#177418) 2025-10-22 [email protected] Remove the x64 version of build_ios_framework_module_test (flutter/flutter#177136) 2025-10-22 [email protected] Fix accessibility events not being correctly translated to ATK (flutter/flutter#176991) 2025-10-22 [email protected] Roll Skia from b55bd60ed95b to 8cd449e4953b (8 revisions) (flutter/flutter#177405) 2025-10-22 [email protected] Roll Dart SDK from c23010c4f9e6 to 75f6ccb9bdc5 (4 revisions) (flutter/flutter#177399) 2025-10-22 [email protected] Fixes crash when adding and removing mulitple page-based route (flutter/flutter#177338) 2025-10-22 [email protected] Move child parameter to end of RefreshIndicator constructor (flutter/flutter#177019) 2025-10-22 [email protected] refactor: migrate OpenUpwardsPageTransitionsBuilder to widgets (flutter/flutter#177080) 2025-10-22 [email protected] Delete stray 'text' file (flutter/flutter#177355) ...
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.
…er#177333)" (flutter#177468) <!-- start_original_pr_link --> Reverts: flutter#177333 <!-- end_original_pr_link --> <!-- start_initiating_author --> Initiated by: reidbaker <!-- end_initiating_author --> <!-- start_revert_reason --> Reason for reverting: Possibly broke the tree see flutter#177465 <!-- end_revert_reason --> <!-- start_original_pr_author --> Original PR Author: reidbaker <!-- end_original_pr_author --> <!-- start_reviewers --> Reviewed By: {justinmc} <!-- end_reviewers --> <!-- start_revert_body --> This change reverts the following previous change: 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. <!-- end_revert_body --> Co-authored-by: auto-submit[bot] <[email protected]>
…ls (flutter#177333)" (flutter#177468)" (flutter#177499) <!-- start_original_pr_link --> Reverts: flutter#177468 <!-- end_original_pr_link --> <!-- start_initiating_author --> Initiated by: reidbaker <!-- end_initiating_author --> <!-- start_revert_reason --> Reason for reverting: did not break tree see flutter#177472 <!-- end_revert_reason --> <!-- start_original_pr_author --> Original PR Author: auto-submit[bot] <!-- end_original_pr_author --> <!-- start_reviewers --> Reviewed By: {fluttergithubbot} <!-- end_reviewers --> <!-- start_revert_body --> This change reverts the following previous change: <!-- start_original_pr_link --> Reverts: flutter#177333 <!-- end_original_pr_link --> <!-- start_initiating_author --> Initiated by: reidbaker <!-- end_initiating_author --> <!-- start_revert_reason --> Reason for reverting: Possibly broke the tree see flutter#177465 <!-- end_revert_reason --> <!-- start_original_pr_author --> Original PR Author: reidbaker <!-- end_original_pr_author --> <!-- start_reviewers --> Reviewed By: {justinmc} <!-- end_reviewers --> <!-- start_revert_body --> This change reverts the following previous change: 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. <!-- end_revert_body --> <!-- end_revert_body --> Co-authored-by: auto-submit[bot] <[email protected]>
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
///).