From 6f775ef2ffa73f219fc3c54925195a70173f37d6 Mon Sep 17 00:00:00 2001 From: Simon Beck Date: Fri, 20 Jan 2023 09:34:40 +0100 Subject: [PATCH] Extend PR checklist This will adjust the checklist in the PR template to contain more context and expectations how a PR should be presented before it's review ready. As discussed in https://github.com/vshn/component-appcat/pull/77 --- .github/PULL_REQUEST_TEMPLATE.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cdcc078..e2119f0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,26 @@ -## Summary -* Short summary of what's included in the PR -* Give special note to breaking changes: List the exact changes or provide links to documentation. + ## Checklist -- [ ] PR contains a single logical change (to keep release notes relevant) -- [ ] Categorize the PR by setting a good title and adding one of the labels: - `bug`, `enhancement`, `documentation`, `change`, `breaking`, `dependency` - as they show up in the changelog -- [ ] Link this PR to related issues -- [ ] I have run `make test-e2e` and e2e tests pass successfully +- [ ] The PR has a meaningful title. It will be used to auto generate the + changelog. + The PR has a meaningful description that sums up the change. It will be + linked in the changelog. +- [ ] PR contains a single logical change (to build a better changelog). +- [ ] Update the documentation. +- [ ] Categorize the PR by adding one of the labels: + `bug`, `enhancement`, `documentation`, `change`, `breaking`, `dependency` + as they show up in the changelog. +- [ ] Link this PR to related issues or PRs. + +