cisagov / .github

Default community health files for cisagov
Creative Commons Zero v1.0 Universal
6 stars 11 forks source link

Update pull request template with pre- and post- approval checklists #16

Closed hillaryj closed 2 years ago

hillaryj commented 3 years ago

šŸ’” Summary

As per discussion in https://github.com/cisagov/kali-packer/pull/57, we'd like to change Checklist to Pre-approval checklist and then also have templated text for post-approval and post-merge.

Motivation

Sometimes, a PR requires work after it's merged. To make it easier to remember to do that work, we would like to include those tasks as checkboxes; however, we also prefer all checkboxes to be checked prior to review to indicate that it's ready.

As per discussion in https://github.com/cisagov/kali-packer/pull/57, we'd like to change Checklist to Pre-approval checklist and then also have templated text for post-approval and post-merge.

Implementation notes

Example, as done by @jsf9k in the linked PR:

## āœ… Pre-approval checklist ##

...

## āœ… Post-approval checklist ##
- [ ] Task

## āœ… Post-merge checklist ##
- [ ] Task

Since this isn't applicable to most PRs, we may also want to make those checklists commented-out by default.

Acceptance criteria

How do we know when this work is done?