From a431187313068bd8d43968385a563a4c39cb191a Mon Sep 17 00:00:00 2001 From: Mateusz Hawrus <48822818+nieomylnieja@users.noreply.github.com> Date: Wed, 24 Jan 2024 18:14:01 +0100 Subject: [PATCH] doc: Update PR template (#244) --- .github/pull_request_template.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2ce04047..9906a3b3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,7 @@ ## Motivation -Describe what is the motivation behind the proposed changes. If possible reference the current solution/state of affairs. +Describe what is the motivation behind the proposed changes. +If possible reference the current solution/state of affairs. ## Summary @@ -15,11 +16,14 @@ List related changes from other PRs (if any). - Describe how to check introduced code changes manually. Simple `main.go` which takes advantage of the introduced changes is preferred (if possible and useful). - Take care of test coverage on unit, integration or even end-to-end levels. -## Checklist +## Release Notes -- [ ] Include this change in Release Notes? - - If yes, write 1-3 sentences about the changes here and explicitly list all changes that can surprise our users. -- [ ] Are these changes required to be in sync with the API? Example of such can be extending a `manifest.Object` with a new field. -It won't be usable until Nobl9 platform version is rolled out which can handle this field. - - If yes, you **MUST NOT** create an official release, instead, use a pre-release version, like `v1.1.0-rc1`. - - If the changes are independent of Nobl9 platform version, you can release an offical version, like `v1.1.0`. +If this change should be part of the Release Notes, +**replace this entire paragraph** with 1-3 sentences about the changes. +Otherwise, you **MUST** remove this section entirely. + +## Breaking Changes + +Does this PR contain any breaking changes? +If so **replace this entire paragraph** with a description of these changes. +Otherwise, you **MUST** remove this section entirely.