This is to get the reviewer in the mood, to understand what part of the app is being touched here
EX: "This PR allows users to upload profile images. It includes S3 code, a worker job for generating thumbnails off-of-web-thread, and tests"
This is the most likely file diff to start with, and points you down a road for further investigation of the code living behind the feature.
EX: The form is in views/users/profile_picture_form.erb, and then look into the controller from there.
This is a pretty common step to skip: "Oh, the code looks good, and tests pass, I bet it works". Actually try it out! This step makes it easy to git checkout branchname and have a look yourself.
EX: Visit localhost:3000/users/profile/edit to test out the UI. Make sure Sidekiq/foreman is running. Also try uploading a corrupted image to see the errors.
This can explain architectural decisions or other points of interest in the potential addition to the codebase.
EX: This is the feature we punted because we didn't have Sidekiq enabled. This sets up Sidekiq, Redis, etc. Unblocks lots of queue-type feature work, hence the generalization of some worker classes
Make it easy on your reviewer to look up the story that drove this work. All your stories are well-groomed and up to date in your issue tracking system, right?
_EX: #4236
We really like to use Record.it for both feature demos and bug reports. Easy gif generation goes a long way
-
Do migrations need to be run?
-
Are there any additional deployment instructions/requirements?