Addresses issue: #
- List work to be done before PR can be reviewed
- Keep this as brief as possible, this is not a place for storytelling
bundle install
orbundle exec pod install
- Reading some backstory
- Set up credentials someuser@domain.com/password in the “foo” database
Be explicit about the scope of the PR. Describe what works.
Also describe what the PR is not meant to accomplish and what is known to be broken/missing/wrong.
Describe instructions on how to test these changes from the viewpoint of someone who has no familiarity of what lead you here; they often may not. It is your burden—not the reviewer’s—to supply context for a reasonable review. Give the reviewer the right tools so they are more likely to understand and, hopefully, approve your changes.
These instructions could be written out or…
- You can also use ordered lists
- If steps have an explicit order
If you need to include code snippets use the block format with the correct language so the syntax is properly colored.
- (void)viewDidLoad
{
[super viewDidLoad];
// Code described here for reasons
}
CI will run tests for some projects but this is your chance to talk about why some tests are failing and why they haven't been addressed in this PR. It’s polite to include something like “All tests pass” so the reviewer is aware that you ran tests before opening the PR.
Space for any closing thoughts, other approaches considered but not implemented, etc.