From 39f9bd54078276082fb28e295de5a4b3d4434bc2 Mon Sep 17 00:00:00 2001 From: gfreeman-navapbc <129095098+gfreeman-navapbc@users.noreply.github.com> Date: Thu, 20 Jun 2024 09:45:30 -0700 Subject: [PATCH] PLT-469: Updated pull request template and added CONTRIBUTING.md (#113) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## ๐ŸŽซ Ticket https://jira.cms.gov/browse/PLT-469 ## ๐Ÿ›  Changes Added the updated pull request template and contribution guidelines from [ab2d-bcda-dpc-platform #87](https://github.com/CMSgov/ab2d-bcda-dpc-platform/pull/87) ## โ„น๏ธ Context for reviewers Jason is rolling off of the project, so we're updating the pull requests templates to reflect our new ISSO @SJWalter11. We're also taking this opportunity to introduce a new contribution guidelines file, as to not clog up the average PR with extra steps. ## โœ… Acceptance Validation The pull request template should be reflected on the creation of new PRs. --- .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 00000000..c14eafa8 --- /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 846812d6..21ea69ce 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,24 +1,21 @@ ## ๐ŸŽซ Ticket -https://jira.cms.gov/browse/DPC-xxx +https://jira.cms.gov/browse/... ## ๐Ÿ›  Changes -(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.) + -## โœ… Acceptance Validation + -(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. +