(In each category, choose the option that most applies. Optionally, provide more details or explanation in the "Comments".)
- JIRA (
r-jira)- PASS : The PR has a JIRA reference. (Or: it does not need one.)
- ISSUE: Please file a ticket in JIRA and place it in the subject
- COMMENTS: (optional)
- Test results (
r-test)- PASS: The test results are all-clear.
- PASS: The test results have failures, but these have been individually inspected and found to be irrelevant.
- ISSUE: The test failures need to be resolved.
- COMMENTS: (optional)
- Code quality (
r-code)- PASS: The functionality, purpose, and style of the code seems clear+sensible.
- ISSUE: Something was unclear to me.
- ISSUE: The approach should be different.
- COMMENTS: (optional)
- Run it (
r-run)- PASS: I executed the code in a few plausible ways, and it behaved as expected.
- ISSUE: I executed the code in a few plausible ways, and it had a problem.
- COMMENTS: (optional)
- User impact (
r-users)- PASS: The change would be intuitive or unnoticeable for a majority of users who work with this feature.
- ISSUE: The change would noticeably impact the user-experience (eg requiring retraining).
- PASS: The change would noticeably impact the user-experience (eg requiring retraining), but this has been addressed with a suitable transition/communication plan.
- COMMENTS: (optional)
- Technical impact (
r-technical)- PASS: The change preserves compatibility with existing callers/code/downstream.
- PASS: The change potentially affects compatibility, but the risks have been sufficiently managed.
- ISSUE: The change potentially affects compatibility, and the risks have not been sufficiently managed.
- COMMENTS: (optional)
- Maintainability (
r-maint)- PASS: The change sufficiently improves test coverage, or the change is trivial enough that it does not require tests.
- PASS: The change does not sufficiently improve test coverage, but special circumstances make it important to accept the change anyway.
- ISSUE: The change does not sufficiently improve test coverage.
- COMMENTS: (optional)
- Documentation (
r-doc)- PASS: There are relevant updates for the documentation, or the changes do not require documentation.
- ISSUE: The user documentation should be updated.
- ISSUE: The administrator documentation should be updated.
- ISSUE: The developer documentation should be updated.
- COMMENTS: (optional)