Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update PR template #244

Merged
merged 1 commit into from
Jan 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Loading