Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Review and Follow Up to PR Template #1235

Merged
merged 8 commits into from Oct 30, 2020
Merged

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Oct 30, 2020

Motivation

We've been talking about our PR process for the last few weeks, and we've identified some issues:

  • we don't know who should review a PR
  • we don't know how urgent PR reviews are
  • it's hard to tell how much of a design or ticket is implemented in a PR
  • we don't consistently track follow-up tasks
  • sometimes we forget documentation or tests

Solution

Make changes to the PR template:

  • Add a Review section
  • Add a Follow Up section
  • Add a checklist to Solution with docs and tests
  • Edit some existing section text so it's shorter

Related Issues

#1177 was my original suggestion, but it's way too long.

Follow Up

Move the reviewer guidelines from #1177 into the dev guide in the book, if we think that's a good idea.

@teor2345 teor2345 added A-infrastructure Area: Infrastructure changes C-enhancement Category: This is an improvement labels Oct 30, 2020
@teor2345 teor2345 self-assigned this Oct 30, 2020
@teor2345 teor2345 added this to Review in progress in 🦓 via automation Oct 30, 2020
@hdevalence hdevalence merged commit adbd338 into main Oct 30, 2020
🦓 automation moved this from Review in progress to Done Oct 30, 2020
@hdevalence hdevalence deleted the pr-template-review-follow-up branch October 30, 2020 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-infrastructure Area: Infrastructure changes C-enhancement Category: This is an improvement
Projects
No open projects
🦓
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants