- Ticket/Issue:
- Design Doc:
Update the checklist on each revision:
-
I have reviewed, tested and understand all changes
If not, why:
-
I have filled out the Description and Testing sections above
If not, why:
-
I have updated the Revision History section (if publishing a new revision)
If not, why:
-
Build and Unit tests are passing
If not, why:
-
Unit test coverage for changes is adequate (> 80%)
If not, why:
-
Integration tests pass locally
If not, why:
-
I have updated integration tests (if needed)
If not, why:
-
I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise)
If not, why:
-
I have added explanatory comments for complex logic, new classes/methods and new tests
If not, why:
-
I have updated README/documentation (if needed)
If not, why:
-
I have clearly called out breaking changes (if any)
If not, why:
All reviewers please ensure the following are true before reviewing each revision:
- Reviewee checklist has been accurately filled out
- Code changes align with stated purpose in description
- Test coverage adequately validates the changes