Skip to content

Commit 5f965d2

Browse files
authored
Update the pull request template.
1 parent b98f086 commit 5f965d2

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ Please make sure that your [PR allows edits from maintainers](https://help.githu
22

33
![Allow edits from maintainers](https://help.github.com/assets/images/help/pull_requests/allow-maintainers-to-make-edits-sidebar-checkbox.png)
44

5-
After creating the PR, please add a commit that adds a bullet-point under the `-SNAPSHOT` section of [CHANGES.md](https://github.com/diffplug/spotless/blob/main/CHANGES.md), [plugin-gradle/CHANGES.md](https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md), and [plugin-maven/CHANGES.md](https://github.com/diffplug/spotless/blob/main/plugin-maven/CHANGES.md) which includes:
5+
After creating the PR, please add a commit that adds a bullet-point under the `[Unreleased]` section of [CHANGES.md](https://github.com/diffplug/spotless/blob/main/CHANGES.md), [plugin-gradle/CHANGES.md](https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md), and [plugin-maven/CHANGES.md](https://github.com/diffplug/spotless/blob/main/plugin-maven/CHANGES.md) which includes:
66

77
- [ ] a summary of the change
88
- either
99
- [ ] a link to the issue you are resolving (for small changes)
1010
- [ ] a link to the PR you just created (for big changes likely to have discussion)
1111

12-
If your change only affects a build plugin, and not the lib, then you only need to update the `CHANGES.md` for that plugin.
12+
If your change only affects a build plugin, and not the lib, then you only need to update the `plugin-foo/CHANGES.md` for that plugin.
1313

14-
If your change affects lib in an end-user-visible way (fixing a bug, updating a version) then you need to update `CHANGES.md` for both the lib and the build plugins. Users of a build plugin shouldn't have to refer to lib to see changes that affect them.
14+
If your change affects lib in an end-user-visible way (fixing a bug, updating a version) then you need to update `CHANGES.md` for both the lib and all build plugins. Users of a build plugin shouldn't have to refer to lib to see changes that affect them.
1515

1616
This makes it easier for the maintainers to quickly release your changes :)

0 commit comments

Comments
 (0)