Skip to content

Commit 6c31eb2

Browse files
committed
update pr template
1 parent 8c4dd9c commit 6c31eb2

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

.github/pull_request_template.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Motivation
22

3-
Describe what is the motivation behind the proposed changes. If possible reference the current solution/state of affairs.
3+
Describe what is the motivation behind the proposed changes.
4+
If possible reference the current solution/state of affairs.
45

56
## Summary
67

@@ -15,11 +16,14 @@ List related changes from other PRs (if any).
1516
- Describe how to check introduced code changes manually. Provide example invocations and applied YAML configs.
1617
- Take care of test coverage on unit and end-to-end levels.
1718

18-
## Checklist
19+
## Release Notes
1920

20-
- [ ] Include this change in Release Notes?
21-
- If yes, write 1-3 sentences about the changes here and explicitly list all changes that can surprise our users.
22-
- [ ] Are these changes required to be in sync with the API? Example of such can be extending adding support of new API.
23-
It won't be usable until Nobl9 platform version is rolled out which exposes this API.
24-
- If yes, you **MUST NOT** create an official release, instead, use a pre-release version, like `v1.1.0-rc1`.
25-
- If the changes are independent of Nobl9 platform version, you can release an offical version, like `v1.1.0`.
21+
If this change should be part of the Release Notes,
22+
**replace this entire paragraph** with 1-3 sentences about the changes.
23+
Otherwise, you **MUST** remove this section entirely.
24+
25+
## Breaking Changes
26+
27+
Does this PR contain any breaking changes?
28+
If so **replace this entire paragraph** with a description of these changes.
29+
Otherwise, you **MUST** remove this section entirely.

0 commit comments

Comments
 (0)