New PR Template

pr-template.md

Intent

This is a template for a new pull request (PR). There are particular expectations upon engineers for communicating their changes to reviewers in a proper and useful manner. This template intends to make this as easy as possible and to reduce the amount of times that a reviewer has to go over the PR.

Template

**References [ticket-name](ticket-link).**

### Original Problem
Summary of original problem.

### Proposed Solution
Summary of proposed solution.

### Endpoint
**This sentence must be true for this ticket to be considered resolved.**

### Changes
* Bulletpoints of individual changes.

### Diffs (if applicable)
**Before**:
Screenshot highlighting sections to be changed.
**After**:
Screenshot highlighting sections that are new or have been changed.

Disclaimer

In theory, by posting a PR, the engineer asserts the following:

• I have reviewed my changes and deem the PR to be in a deployable state.
• I have caught any and all bugs to my knowledge.
• I have verified that all unit tests, live tests, and JS/Angular tests (Jasmine) pass.
• I deem the approach in this code to be efficient and sensible.
• I have properly rebased and reorganized my commit history to be informative and clear of clutter and extraneous comments.

Next Steps

• Request a review from, initially, a team member.
• If the PR merits a review by an engineer outside the feature crew, request a review from that engineer only after fulfilling the above.
• If a PR is taking a while to be reviewed, or you end up in a "yeah I'm waiting on a squirrel" state in your standup, speak to your crew lead for advice on what to do next. Said advice typically includes the following:
  • Have you asked your team members to review the PR?
  • Have you solved all the issues raised with your PR?
  • Is your PR in a deployable (working and acceptable) state?
  • Have you done all else in your capacity to get this PR reviewed?