diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f04d400..e29ca8d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,31 +1,29 @@ -**Please specify the area for this PR** +# Description of Changes +_Summarize the changes you made as part of this PR._ -**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? - [ ] Gosec scans - Fix all MEDIUM and higher findings and/or annotate a finding per gosec instructions: https://github.com/securego/gosec#annotating-code to address why a finding is not a security issue -Documentation +### Documentation - [ ] Does the registry operator documentation need to be updated with your changes? - -**Testing changes** +# 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._ [Running Unit Tests](https://github.com/devfile/registry-operator/blob/main/CONTRIBUTING.md#unit-tests) [Running Integration Tests](https://github.com/devfile/registry-operator/blob/main/CONTRIBUTING.md#integration-tests) - -**Special notes to the reviewer**: +# Notes To Reviewer +_Any notes you would like to include for the reviewer._