DESCRIPTION GOES HERE. Try to describe both what is changing and why this is important
Make sure you run when adding / updating a package
What did you change from a design standpoint?
What did you change in the code itself?
If you are updating a dependency, explain why this is needed.
π· Screenshots
If there were visual changes to the application with this change, please include before and after screenshots here. If it has animation, please use screen capture software like to make a gif.
π References
Include at at least one link to an explanation + requirements for this change, and more if at all possible. Typically this is a Jira/GitHub Issue, but could also be links to Zendesk tickets, RFCs, rollout plan or Slack conversations (for Slack conversations, make sure you provide a summary of the conversation under βChangesβ).
π― Testing
Describe how this can be tested by reviewers. Please be specific about anything not tested and reasons why.
Make sure you add unit and integration tests.
If this is on a hot path, add load or performance tests
Especially for dependency updates we also need to make sure that there is no impact on performance.
β π« This change has been tested in a Webtask
β π« This change has unit test coverage
β π« This change has integration test coverage
β π« This change has been tested for performance
π Deployment
Can this change be merged at any time? What will the deployment of the change look like? Does this need to be released in lockstep with something else?
β π« This can be deployed any time
or
β οΈ This should not be merged until:
Other PR is merged because REASON
After date because REASON
Other condition: REASON
π‘ Rollout
Explain how the change will be verified once released. Manual testing? Functional testing?
In order to verify that the deployment was successful we will β¦
π₯ Rollback
Explain when and why we will rollback the change.
We will rollback if β¦
π Procedure
Explain how the rollback for this change will look like, how we can recover fast.
π₯ Appliance
Note to reviewers: ensure that this change is compatible with the Appliance.
βοΈ Changes
π· Screenshots
If there were visual changes to the application with this change, please include before and after screenshots here. If it has animation, please use screen capture software like to make a gif.
π References
π― Testing
β π« This change has been tested in a Webtask
β π« This change has unit test coverage
β π« This change has integration test coverage
β π« This change has been tested for performance
π Deployment
β π« This can be deployed any time
π‘ Rollout
In order to verify that the deployment was successful we will β¦
π₯ Rollback
We will rollback if β¦
π Procedure
π₯ Appliance
Note to reviewers: ensure that this change is compatible with the Appliance.