[EPIC] Production Release Readiness (MIDAS)

[aj-stein-nist]

User Story:

As a NIST OSCAL team member, in order to ensure this project is well-designed, implemented, tested, and documented, I want itemized list of NIST publication requirements for publishing research software, status, and supported evidence for individual items per and other relevant guidelines.

Goals:

In order to publish this repository and make it available for community use, we need to consider, identify, implement, and evidence how this repository, developers, and processes meet the following organizational requirements.

• NIST S 1801.03

  • Code is:
    • Identified as informational or not (e.g., part of the supplemental information in a narrative publication) and not
      intended for re-use.
    • Identified as intended for re-use or not (e.g., in a specific scientific area) or the public is being invited to
      contribute to it. Add Contribution Guidelines for Developers #22
    • Identifies a testing plan (e.g., unit, integration, acceptance, performance) was developed, followed, and
      documented.
    • Identifies how continuous testing was conducted during updates and new builds.
    • Identifies how code includes appropriate IT security and privacy controls. (For more information, see Develop/Test
      Resources available at https://inet.nist.gov/adlp/open-access-research-oar/publishing-
      instructions/publishing-software). (After you create a record for your code in MIDAS and submit it for
      review, your ITSO will check for security (of software); will look at the method for release of software if it is
      something other than GitHub; will make sure it does not compromise dependencies (I.e., internal databases
      or other physical resources to which it is linked).
  • Documentation is available as appropriate and includes:
    • Project README File #25
    • Function-level documentation - every file has a description of what it does, whether as documentation in
      the code or in auxiliary files
    • Information about how a binary was produced
    • System requirements and prerequisites (e.g., OS version, memory, dependencies)
    • Installation instructions
    • User instructions/guides Add Contribution Guidelines for Developers #22
    • API specifications #27 Design Abstract Base Class and Interfaces for Common Model #20
    • A changelog file #26
    • Specification of maturity level (i.e., is the software still being actively developed, are you expecting
      feedback on performance and usability, is the project completed)
    • A communication to users of your intent to provide (or not provide) support Add Contribution Guidelines for Developers #22
  • Licenses and disclaimers provide:
    • NIST license and disclaimers (https://www.nist.gov/open/copyright-fair-use-and-licensing-statements-srd-
      data-software-and-technical-series-publications) included (including commercial product disclaimer,
      https://inet.nist.gov/adlp/disclaimers-publications, if necessary) Add Contribution Guidelines for Developers #22
  • External collaborators who were part of this project been credited
  • Third-party software licenses permit modification and/or redistribution (https://www.gnu.org/licenses/gpl-
    faq.en.html#GPLUSGovAdd)
    • Appropriate licensing is included Add Contribution Guidelines for Developers #22
    • Files modified by NIST contain notice that modifications are released to the public domain as
      appropriate Add Contribution Guidelines for Developers #22

• FAIR Principles

• Findable

  • (Meta)data are assigned a globally unique and persistent
    identifier
  • Data are described with rich metadata (defined by R1 below)
  • Metadata clearly and explicitly include the identifier of the data
    they describe
  • (Meta)data are registered or indexed in a searchable resource

• Accessible

  • (Meta)data are retrievable by their identifier using a standardized communications protocol
    • The protocol is open, free, and universally implementable
    • The protocol allows for an authentication and authorization
      procedure, where necessary
  • Metadata are accessible, even when the data are no longer available

• Interoperable

  • (Meta)data use a formal, accessible, shared, and broadly
    applicable language for knowledge representation.
  • (Meta)data use vocabularies that follow FAIR principles
  • (Meta)data include qualified references to other (meta)data

• Reusable

  • (Meta)data are richly described with a plurality of accurate and
    relevant attributes
    • (Meta)data are released with a clear and accessible data usage
      license
    • (Meta)data are associated with detailed provenance
    • (Meta)data meet domain-relevant community standards

Dependencies:

TBD (N/A at this time).

Acceptance Criteria

• A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
• The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}