diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 72ab1ea66..7a14cf12e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,14 +1,28 @@ +### Description + +Please briefly explain the changes you made here. + + +Please delete either the [master < EPIC] or [master < Task] part, depending on what are your needs. + [master < Epic] PR -- [ ] Check, and update documentation if necessary - [ ] Write E2E tests - [ ] Compare the [benchmarking results](https://bench-graph.memgraph.com/) between the master branch and the Epic branch - [ ] Provide the full content or a guide for the final git message + - [FINAL GIT MESSAGE] [master < Task] PR -- [ ] Check, and update documentation if necessary - [ ] Provide the full content or a guide for the final git message + - **[FINAL GIT MESSAGE]** -To keep docs changelog up to date, one more thing to do: -- [ ] Write a release note here, including added/changed clauses +### Documentation checklist +- [ ] Add the documentation label tag +- [ ] Add the bug / feature label tag +- [ ] Add the milestone for which this feature is intended + - If not known, set for a later milestone +- [ ] Write a release note, including added/changed clauses + - **[Release note text]** +- [ ] Link the documentation PR here + - **[Documentation PR link]** - [ ] Tag someone from docs team in the comments