Skip to content

first draft of a PR checklist #9

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.

Sign up for GitHub

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

Open
jcleary wants to merge 1 commit into
base: master
Choose a base branch
from
Open

first draft of a PR checklist #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions pr_checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# PR Checklist
Bugs and rework are expensive and time-consuming. The purpose of this list is to reduce such waste and increase the teams' overall velocity. Before you open
a Pull Request, check this list to ensure you haven't missed anything.

## Bugs
- has a test been added to test for the bug

## Features
- is there a feature test for the happy-path?
- are there controller tests for other actions?
- are there model tests for all public methods on the models?
- are there unit tests for all public methods on non-model classes?

## APIs
- has the documentation been updated?
- will the change impact existing users of the API?

## Data changes
- have you discussed the impact of data changes?
- do data migrations needs to be run as a result of the change?
- will DB:Slurp need to be updated after the change?

## Application-specific considerations

### MyRewards

- have you checked that the feature works across all themes?
- have you considered the impact on the API?
- have you considered the impact on GPS?
- are there any sidekiq jobs that need to be altered?