Skip to content

Instantly share code, notes, and snippets.

@audreyfeldroy
Last active October 6, 2021 06:17
Show Gist options
  • Save audreyfeldroy/cc71cebbc3efae4fbf028d3e5ed37f84 to your computer and use it in GitHub Desktop.
Save audreyfeldroy/cc71cebbc3efae4fbf028d3e5ed37f84 to your computer and use it in GitHub Desktop.

To help make PR reviews as easy as possible for reviewers with limited time, and to help make reviews more consistent, I thought it would be nice for all @margaritahumanitarian contributors to adopt a self and peer review process. This is based on standard software industry practices for self reviews and peer and higher reviews.

This checklist is for:

  • Self Reviews: Reviewing your own PR upon submission
  • Peer Reviews: All are encouraged to review each other's PRs, even total newbies
  • Core Dev Reviews: Core devs with more experience on the project
  • Maintainer Reviews: Anyone doing a final review before merge

Self-Review Checklist

  • PR title is clear with proper spelling and grammar
  • PR description contains a bulleted list of changes contained in the PR
  • PR links to relevant issues, with keywords to auto-close any issues fully resolved upon merge
  • All automated checks passed
  • Any variables introduced are named clearly and explicitly

Peer and Higher Additional Checklist Items

  • Requests for changes are made as code suggestions whenever possible
  • PR review is submitted with "Request Changes" or "Approved" marked
  • Improve this review checklist if you see anything that could be better

Instructions

  • Copy-paste the relevant checklist(s) to the PR.
  • Change the title to match what type of review it is.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment