zcash-android-wallet-sdk/.github/pull_request_template.md

This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

• Self-review: Did you review your own code in GitHub's web interface? Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.
• Automated tests: Did you add appropriate automated tests for any code changes?
• Manual tests: Did you update the manual tests as appropriate? While we aim for automated testing of the application, some aspects require manual testing. If you had to manually test something during development of this pull request, write those steps down.
• Documentation: Did you update documentation as appropriate? (e.g README.md, etc.)
• Run the app: Did you run the demo app and try the changes?
• Rebase and squash: Did you pull in the latest changes from the main branch and squash your commits before assigning a reviewer? Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

Reviewer

• Checklist review: Did you go through the code with the Code Review Guidelines checklist?
• Ad hoc review: Did you perform an ad hoc review? In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.
• Automated tests: Did you review the automated tests?
• Manual tests: Did you review the manual tests?
• How is Code Coverage affected by this PR? We encourage you to compare coverage before and after changes and when possible, leave it in a better place.
• Documentation: Did you review Docs, README.md, and Architecture.md as appropriate?
• Run the app: Did you run the demo app and try the changes? While the CI server runs the app to look for build failures or crashes, humans running the app are more likely to notice unexpected log messages, UI inconsistencies, or bad output data. Perform this step last, after verifying the code changes are safe to run locally.