From 3c16242c3a711c30d8f01daf5fc4fbf9442bb7d8 Mon Sep 17 00:00:00 2001 From: Jordan Dubrick Date: Tue, 20 Aug 2024 16:34:08 -0400 Subject: [PATCH] Update PR template (#256) Signed-off-by: Jordan Dubrick --- .github/PULL_REQUEST_TEMPLATE.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3cbccd75f..67592a15a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,25 @@ -**Please specify the area for this PR** +# Description of Changes +_Summarize the changes you made as part of this pull request._ -**What does does this PR do / why we need it**: +# Related Issue(s) +_Link the GitHub/GitLab/JIRA issues that are related to this PR._ -**Which issue(s) this PR fixes**: - -Fixes #? - -**PR acceptance criteria**: +# Acceptance Criteria + +### Tests - [ ] Test Coverage - Are your changes sufficiently tested, and are any applicable test cases added or updated to cover your changes? -Documentation (WIP) +### Documentation - [ ] Does the [REST API doc](../index/server/registry-REST-API.adoc) need to be updated with your changes? - [ ] Does the [registry library doc](../registry-library/README.md) need to be updated with your changes? -**How to test changes / Special notes to the reviewer**: +# Tests Performed +_Explain what tests you personally ran to ensure the changes are functioning as expected._ + +# How To Test +_Instructions for the reviewer on how to test your changes._ + +# Notes To Reviewer +_Any notes you would like to include for the reviewer._