Skip to content

Instantly share code, notes, and snippets.

@timcosgrove

timcosgrove/pr_template.md

Created December 29, 2022 02:11
Show Gist options
  • Save timcosgrove/dcee41324198a73fe65682d8541d033b to your computer and use it in GitHub Desktop.
Save timcosgrove/dcee41324198a73fe65682d8541d033b to your computer and use it in GitHub Desktop.
Download ZIP
Testing PR template
Raw
pr_template.md

Description

Relates to #issueid

Acceptance criteria

PR creator: please copy the AC from your issue.

Testing plan

PR creator: please copy the testing plan from your issue, if there is one.

Select Team(s) for PR review

  • Sitewide CMS
  • Public websites
  • Facilities
  • User support
  • Design
  • Accessibility

Review template

Please copy and use this template for your review. 
### Testing done
*Please add clear step-by-step descriptions here, so your testing can be reproduced.*
  
### Screenshots
*Please including screenshots that illustrate your testing.* 
  
### Things to check
- [ ] Has documentation been updated?
- [ ] Have tests been added?
- [ ] Acceptance Criteria in related issue are met.
@jilladams
Copy link

Not an eng, so feel free to push back if this is assumed / always happens, but: Would love to see this include some pointers to thinking about the changes from a higher level best practices view -- e.g. checking whether the code is self-documenting / well-commented (maybe the documentation item covers that?), whether it's extensible / duplicative, etc. I don't think we need to get super detailed on each of those, but just some reminder to look at the changes through that lense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment