Example of Software Release Reconciliation .docx

PAGER 2.0 Software Release

Review Reconciliation Report

Summary:

The latest version of the PAGER code can be found here:

https://github.com/usgs/pager

The DOI for this release can be found here:

https://doi.org/10.5066/F7DN4402

The PAGER code was reviewed by

1)      Eric Thompson, as subject matter expert with a focus on validating the logic, test results, and outputs, as well as the code in general.

2)      John Patton, as a peer review with a focus on software development best practices and security and PII check.

A list of GitHub issues created by the reviewers and/or that I created from their email comments is included below. These issues have all been addressed and closed with fixes, or in one case (#158), put off until an additional feature in ShakeMap has been implemented.

Eric Thompson’s comments :

Most of Eric’s comments had to do with documentation and code readability problems.  See the issues list below for details on these and their resolution.

https://github.com/usgs/pager/issues/29

https://github.com/usgs/pager/issues/31

https://github.com/usgs/pager/issues/158

https://github.com/usgs/pager/issues/166

https://github.com/usgs/pager/issues/179

https://github.com/usgs/pager/issues/180

https://github.com/usgs/pager/issues/181

https://github.com/usgs/pager/issues/182

https://github.com/usgs/pager/issues/183

https://github.com/usgs/pager/issues/184

https://github.com/usgs/pager/issues/185

John Patton’s comments :

1. Add new best practice files to repository (see Issue #171 below)
2. Remove potentially real email address from documentation (see Issue #172 below)

https://github.com/usgs/pager/issues/171

https://github.com/usgs/pager/issues/172

In addition to dealing with the comments from reviewers, a number of other small improvements and bug fixes were implemented, and reviewed, for this release.