From 76db4cb1a55baea9991bccafe2b790407fb9e982 Mon Sep 17 00:00:00 2001 From: Pedro Zanetti Date: Fri, 19 May 2023 14:41:07 -0300 Subject: [PATCH] docs: [ROCK-3382] Update PR template to follow Loadsmart Change Management Policy (#13) --- .github/pull_request_template.md | 50 ++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 881581a2af831..ca61d51998753 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,36 +1,42 @@ -# ROCK-: +## 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`