From 37a1de270c1e356ea54e1b2fbed19cc1ddfdd1b8 Mon Sep 17 00:00:00 2001
From: Grant Freeman <grantfreeman@navapbc.com>
Date: Wed, 12 Jun 2024 10:17:58 -0700
Subject: [PATCH] updated pull request template and added CONTRIBUTING.md

---
 .github/CONTRIBUTING.md          | 15 +++++++++++++++
 .github/pull_request_template.md | 25 +++++++++++--------------
 2 files changed, 26 insertions(+), 14 deletions(-)
 create mode 100644 .github/CONTRIBUTING.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..c14eafa
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contribution expectations
+
+The following expectations apply to each PR:
+
+1. The PR and branch are named for [automatic linking](https://support.atlassian.com/jira-cloud-administration/docs/use-the-github-for-jira-app/) to the most relevant JIRA issue (for example, `JRA-123 Adds foo` for PR title and `jra-123-adds-foo` for branch name).
+2. Reviewers are selected to include people from all teams impacted by the changes in the PR.
+3. The PR has been assigned to the people who will respond to reviews and merge when ready (usually the person filing the review, but can change when a PR is handed off to someone else).
+4. The PR is reasonably limited in scope to ensure:
+   - It doesn't bunch together disparate features, fixes, refactorings, etc.
+   - There isn't too much of a burden on reviewers.
+   - Any problems it causes have a small blast radius.
+   - Changes will be easier to roll back if necessary.
+5. The PR includes any required documentation changes, including `README` updates and changelog or release notes entries.
+6. All new and modified code is appropriately commented to make the what and why of its design reasonably clear, even to those unfamiliar with the project.
+7. Any incomplete work introduced by the PR is detailed in `TODO` comments which include a JIRA ticket ID for any items that require urgent attention.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index c2a38dd..21ea69c 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,24 +1,21 @@
 ## 🎫 Ticket
 
-https://jira.cms.gov/browse/BCDA-xxx
+https://jira.cms.gov/browse/...
 
 ## 🛠 Changes
 
-(What was added, updated, or removed in this PR.)
+<!-- What was added, updated, or removed in this PR? -->
 
-## ℹ️ Context for reviewers
+## ℹ️ Context
 
-(Background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers.)
+<!-- Why were these changes made? Add background context suitable for a non-technical audience. -->
 
-## ✅ Acceptance Validation
+<!-- If any of the following security implications apply, this PR must not be merged without Stephen Walter's approval. Explain in this section and add @SJWalter11 as a reviewer.
+  - Adds a new software dependency or dependencies.
+  - Modifies or invalidates one or more of our security controls.
+  - Stores or transmits data that was not stored or transmitted before.
+  - Requires additional review of security implications for other reasons. -->
 
-(How were the changes verified? Did you fully test the acceptance criteria in the ticket? Provide reproducible testing instructions and screenshots if applicable.)
+## 🧪 Validation
 
-## 🔒 Security Implications
-
-- [ ] This PR adds a new software dependency or dependencies.
-- [ ] This PR modifies or invalidates one or more of our security controls.
-- [ ] This PR stores or transmits data that was not stored or transmitted before.
-- [ ] This PR requires additional review of its security implications for other reasons.
-
-If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.
+<!-- How were the changes verified? Did you fully test the acceptance criteria in the ticket? Provide reproducible testing instructions and screenshots if applicable. -->