Production release readiness & publication in MIDAS

[nikitawootten-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.

NOTE: this issue is derived from usnistgov/nmetaschema#21

Goals:

The following NIST requirements must be met:

• [ ] NIST S 1801.03 (supplemented by this checklist)
  • [x] How do you expect your code/software to be used (choose 1):
    • Code is informational (e.g. part of the supplemental information in a narrative publication) and not intended for re-use
    • Code itself is intended for re-use (e.g. in a specific scientific area) or the public is being invited to contribute to it
  • [x] Developing and Testing:
    • [x] A testing plan was developed, followed, and documented. The testing plan is available at a specified link. (see #31)
    • [x] Continuous testing was conducted during updates and new builds. (see usnistgov/metaschema-node#2)
    • [x] Code includes appropriate IT security and privacy controls.
  • [ ] Documenting:
    • [ ] Documentation is available as appropriate as: (choose 1)
      • Integrated with the source code
      • On separate web pages (e.g. nist.gov, pages.nist.gov) (see usnistgov/metaschema-node#17)
      • In a separate publication (see https://pages.nist.gov/metaschema/)
      • Other
    • [ ] Documentation includes, as appropriate:
      • [x] A readme (see usnistgov/metaschema-node#1)
      • [x] Function-level documentation
      • Information about how a binary was produced
      • [x] System requirements and prerequisites (e.g., OS version, memory, dependencies)
      • [ ] Installation instructions
      • [ ] User instructions/guides
      • [x] usnistgov/metaschema-node#17
      • [x] A changelog file (included in GitHub releases)
      • [ ] Specification of maturity level (i.e. is the software still being developed,, are you expecting feedback on performance and usability, is the project completed)
      • [x] A communication to users of your intent to provide (or not provide) support (see usnistgov/metaschema-node#1 contribution notice)
  • [ ] License and disclaimers:
    • [x] NIST license and disclaimers (see usnistgov/metaschema-node#1)
    • [x] External collaborators who were part of this project have been credited
    • [ ] Third-party software licenses permit modification and/or redistribution (#30)
      • [ ] Appropriate licensing is included (#30)
      • [x] Files modified by NIST contain notice that modifications are released to the public domain as appropriate (see usnistgov/OSCAL#1 contribution notice)
• [ ] Fair Principles (supplemented by this checklist)
  • [ ] Findable (Will be satisfied by MIDAS entry)
    • [ ] (Meta)data are assigned a globally unique and persistent identifier
    • [ ] Data are described with rich metadata (defined by R1 below)
    • [x] Metadata clearly and explicitly include the identifier of the data they describe
    • [ ] (Meta)data are registered or indexed in a searchable resource
  • [x] Accessible (satisfied by NPM)
    • [x] (Meta)data are retrievable by their identifier using a standardised communications protocol
    • [x] Metadata are accessible, even when the data are no longer available
  • [x] Interoperable (satisfied by NPM)
    • [x] (Meta)data use a formal, accessible, shared, and broadly applicable language for knowledge representation.
    • [x] (Meta)data use vocabularies that follow FAIR principles
    • [x] (Meta)data include qualified references to other (meta)data
  • [x] Reusable (satisfied by NPM)
    • [x] (Meta)data are richly described with a plurality of accurate and relevant attributes
      • [x] (Meta)data are released with a clear and accessible data usage license
      • [x] (Meta)data are associated with detailed provenance
      • [x] (Meta)data meet domain-relevant community standards

Dependencies:

The major epics describing the MVP:

• usnistgov/OSCAL#5
• usnistgov/OSCAL#14
• usnistgov/OSCAL#15
• TBD...