Skip to content

Commit

Permalink
updated pull request template and added CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gfreeman-navapbc committed Jun 12, 2024
1 parent 68f0e7c commit 37a1de2
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 14 deletions.
15 changes: 15 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
25 changes: 11 additions & 14 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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. -->

0 comments on commit 37a1de2

Please sign in to comment.