Skip to content

Commit 862fb5a

Browse files
authored
Added a pull request template. (#196)
This will shift the burden of keeping the changelog up-to-date from the maintainers to PR submitters, which will help good PR's to get released more quickly.
1 parent b69cc71 commit 862fb5a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

PULL_REQUEST_TEMPLATE.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
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/master/CHANGES.md) and [plugin-gradle/CHANGES.md](https://github.com/diffplug/spotless/blob/master/plugin-gradle/CHANGES.md) which includes:
2+
3+
- [ ] a summary of the change
4+
- [ ] a link to the newly created PR
5+
6+
If your change only affects a build plugin, and not the lib, then you only need to update the `CHANGES.md` for that plugin.
7+
8+
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.
9+
10+
This makes it easier for the maintainers to quickly release your changes :)

0 commit comments

Comments
 (0)