From 2c3f4cb6be37d50d0d0adc1a4a405acde356fbb3 Mon Sep 17 00:00:00 2001 From: Emily Jablonski <65367387+emilyjablonski@users.noreply.github.com> Date: Tue, 4 Jun 2024 17:23:12 -0600 Subject: [PATCH] docs: updated pr template (#4116) --- docs/pull_request_template.md | 56 +++++++++++------------------------ 1 file changed, 17 insertions(+), 39 deletions(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 6a70ee0d76..dbac4e6638 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,52 +1,30 @@ -# Pull Request Template +This PR addresses #(insert-number-here) -## Issue Overview - -This PR addresses #issue - -- [ ] This change addresses the issue in full -- [ ] This change addresses only certain aspects of the issue -- [ ] This change is a dependency for another issue -- [ ] This change has a dependency from another issue +- [ ] Addresses the issue in full +- [ ] Addresses only certain aspects of the issue ## Description -Please include a summary of the change and which issue(s) is addressed. Please also include relevant motivation and context. List any dependencies that are required for this change. +Please include a summary of the change and which issue(s) is addressed. ## How Can This Be Tested/Reviewed? -Provide instructions so we can review. - -Describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration. +Provide instructions so we can review, including any needed configuration, and the test cases that need to be QAd. -## Checklist: +## Author Checklist: -- [ ] My code follows the style guidelines of this project -- [ ] I have added QA notes to the issue with applicable URLs -- [ ] I have performed a self-review of my own code -- [ ] I have reviewed the changes in a desktop view -- [ ] I have reviewed the changes in a mobile view -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules -- [ ] I have assigned reviewers -- [ ] I have run `yarn generate:client` and/or created a migration if I made backend changes that require them -- [ ] My commit message(s) is/are polished, and any breaking changes are indicated in the message and are well-described -- [ ] Commits made across packages purposefully have the same commit message/version change, else are separated into different commits +- [ ] Added QA notes to the issue with applicable URLs +- [ ] Reviewed in a desktop view +- [ ] Reviewed in a mobile view +- [ ] Reviewed considering accessibility +- [ ] Added tests covering the changes +- [ ] Made corresponding changes to the documentation +- [ ] Ran `yarn generate:client` and/or created a migration when required -## Reviewer Notes: +## Review Process: -Steps to review a PR: - -- Read and understand the issue, and ensure the author has added QA notes +- Read and understand the issue +- Ensure the author has added QA notes - Review the code itself from a style point of view - Pull the changes down locally and test that the acceptance criteria is met -- Also review the acceptance criteria on the Netlify deploy preview (noting that these do not yet include any backend changes made in the PR) -- Either explicitly ask a clarifying question, request changes, or approve the PR if there are small remaining changes but the PR is otherwise good to go - -## On Merge: - -If you have one commit and message, squash. If you need each message to be applied, rebase and merge. +- Either (1) explicitly ask a clarifying question, (2) request changes, or (3) approve the PR, even if there are very small remaining changes, if you don't need to re-review after the updates