This repository has been archived by the owner on Nov 6, 2024. It is now read-only.
forked from datahub-project/datahub
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: [ROCK-3382] Update PR template to follow Loadsmart Change Manag…
…ement Policy (#13)
- Loading branch information
Showing
1 changed file
with
28 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |