Python Code Review
This is a technical code review for the Python code.
For the reviewer
@mhearne will be reviewing the Python code
- Should be completed by somebody with adequate understanding of the programming languages used in the project
- May be facilitated/reconciled via GitLab issues and merge requests against the release-candidate branch.
- An MR has been created to make viewing changes easier. This MR should not be merged until all reviews (code, domain, admin/security) have been completed and the code is ready for release. Merge request !132
- Must be documented in the IPDS record
- The reviewer can show that they are satisfied by closing this issue
See the software-management review page for a checklist of things to look for: https://www.usgs.gov/products/software/software-management/types-software-review
For the developer
@degoldberg and @hhunsinger will be the developer points of contact for this review
- All changes made to address the reviewers comments should be made to the release-candidate branch
- Responses to reviewer comments can include:
- Making changes to the code
- Creating an issue to address the issue at a later time
- Explaining why changes will not be made
NOTE: for options 2 & 3 the reviewer and developer should agree to a reasonable resolution that does not compromise code standards
Process
The review process should be as follows:
- Reviewer reviews the code
- Reviewer adds comments to the issue outlining changes that need to be addressed
- Developer addresses each comment either with code changes (to the release-candidate branch), issues, or providing clarifying information to the reviewer
- Steps 1-3 are repeated until the reviewer is satisfied
- Reviewer comments and closes the issue
All reviews will be pointed at the release-candidate branch, so please do not merge that.
Edited by Hunsinger, Heather Elizabeth