Skip to content

Commit 4c5a7ed

Browse files
Update PR template for clarity (#8777)
Attempt to make the PR checklist more clear about expectations: - Retitle the checklist to make it explicit that it's for review, not landing. - Make it explicit that the version, CHANGELOG, and test steps require some action, rather than just personally believing that a PR should be exempt.
1 parent f5f9113 commit 4c5a7ed

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
*List which issues are fixed by this PR. You must list at least one issue.*
44

5-
## Pre-launch Checklist
5+
## Pre-Review Checklist
66

77
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
88
- [ ] I read the [Tree Hygiene] page, which explains my responsibilities.
99
- [ ] I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use `dart format`.)
1010
- [ ] I signed the [CLA].
1111
- [ ] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]`
1212
- [ ] I [linked to at least one issue that this PR fixes] in the description above.
13-
- [ ] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes].
14-
- [ ] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style], or this PR is [exempt from CHANGELOG changes].
15-
- [ ] I updated/added relevant documentation (doc comments with `///`).
16-
- [ ] I added new tests to check the change I am making, or this PR is [test-exempt].
13+
- [ ] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or I have commented below to indicate which [version change exemption] this PR falls under.
14+
- [ ] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style], or I have commented below to indicate which [CHANGELOG exemption] this PR falls under.
15+
- [ ] I updated/added any relevant documentation (doc comments with `///`).
16+
- [ ] I added new tests to check the change I am making, or I have commented below to indicate which [test exemption] this PR falls under.
1717
- [ ] All existing and new tests are passing.
1818

1919
If you need help, consider asking for advice on the #hackers-new channel on [Discord].
@@ -26,7 +26,7 @@ If you need help, consider asking for advice on the #hackers-new channel on [Dis
2626
[Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md
2727
[linked to at least one issue that this PR fixes]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#overview
2828
[pub versioning philosophy]: https://dart.dev/tools/pub/versioning
29-
[exempt from version changes]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#version
29+
[version change exemption]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#version
3030
[following repository CHANGELOG style]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog-style
31-
[exempt from CHANGELOG changes]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog
32-
[test-exempt]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#tests
31+
[CHANGELOG exemption]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog
32+
[test exemption]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#tests

0 commit comments

Comments
 (0)