3.0.0 Technical Code Review
This issue documents the Technical Code Review for an "Approved Software" release of the nshm-alaska repository, with tag 3.0.0 representing the 2023 Alaska NSHM. A technical code review was not performed for the provisional release of this repository. For reference, the technical code review for nshm-hawaii is here: nshm-hawaii#4 (closed)
Release candidate tag for review: 3.0.0rc-branch
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.
USGS software review information: https://www.usgs.gov/products/software/software-management/types-software-review