Code Review
Please provide a Code Review of the ORByT scientific software. Information on the policies and procedures related to USGS Software are available from this site:
A checklist outlining the overall process is attached:
USGS-Software-Planning-Checklist_NOV2019.docx
More specifically, refer to this page for details on the review process:
For convenience, here is the most relevant information for the purposes of this review request:
Code Review Code reviews ensure structural code quality and should be performed frequently throughout the stages of software development. This might mean different things depending on the individual project/team but some typical quality checks include:
- Coding standards
- Unit tests passing
- User input cleansing
- Memory leaks
- Vulnerabilities
- Optimizations
Code reviews should be performed by a trusted developer with applicable programming knowledge. This person need not have thorough subject-matter knowledge on the science topic.
Tools such as linters can automate parts of code review, freeing the human reviewer to focus on the substance of the code. For more information, refer to the automation section on the Test portion of the Software Management web site.
Review with Git
- Assign the issue to the reviewer.
- The reviewer will reply to the issue with review comments and notification that the review has been completed. This may involve iteratively responding to the reviewer through the Issue feature and updating the repository to resolve review comments.