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

docs: [ROCK-3382] Update PR template to follow Loadsmart Change Management Policy #13

Merged
merged 1 commit into from
May 19, 2023
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
50 changes: 28 additions & 22 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,42 @@
# ROCK-<num>: <issue title>
## Motivation and context for the change

## Description
> Describe the motivation against creating this change and, if applicable, describe the current behavior and any relevant screenshots or diagrams (if applicable).

_please describe your changes here to help reviewer_
## A clear description of the change

## Checklist
> Describe the change, including new behavior, possible impacts, and any relevant screenshots or diagrams (if applicable).

This PR complies to:
## Showroom

- [ ] Documented (API SPECs, software architecture changes, and code comments where necessary)
- [ ] Smallest size possible
- [ ] Synced branch with master
- [ ] Tested locally
- [ ] Tested on QA
- [ ] Clog entry (if needed)
- [ ] Production-ready
> Please include a video or screenshot.

## Requirements
## Testing

_please list any other PRs that should be merged before this_
> Inform whether or not the change is covered with automated tests.

* _link 1_
* _link 2_
- [ ] The change is covered with automated tests

## How to test
#### Testing instructions

_please provide instructions for manual testing this PR_
> If the change isn't covered with automated tests, provide a detailed list of steps for the reviewer to test it. You may remove this section in case of automated tests.

## Showroom
## Rollback

- [ ] The change can be automatically rolled back

#### Rollback instructions

> If the rollback cannot be performed automatically, provide a detailed list of the steps needed to complete a rollback. Add any relevant link to the documentation if applicable. You may remove this section in case of support for automated rollback.

## Jira Ticket

> Please include Jira Ticket.

_please include a video or screenshot_
## Change Management Labels

## Metrics
> Based on the Loadsmart Change Management Policy, every change should be documented. The documentation must include the type of the change. Check that this PR is labeled with at least one of the following labels:

_please provide a list of metric or analytics implemented in this PR - if applicable_
- `change-type: infrastructure`
- `change-type: source code`
- `change-type: database`
- `change-type: documentation`