FRSM checklist - $NAME

This FRSM checklist contains a set of questions extracted from the FAIR Research Software Metric to assess the research software $NAME regarding the FAIR metrics for research software.

FRSM-01: Persistent Identifier

Does the software have a globally unique and persistent identifier?

• FRSM-01.1: Software has a human and machine-readable unique identifier that is resolvable to a machine-readable landing page and follows a defined unique identifier syntax.
• FRSM-01.2: Identifier uses an identifier scheme that guarantees globally uniqueness and persistence.
• FRSM-01.3: Identifier scheme is commonly used in the domain.

FRSM-02: Components Identifiers

Do the different components of the software have their own identifiers?

• FRSM-02.1: Where the "software" consists of multiple distinct components, each component has a distinct identifier.
• FRSM-02.2: The relationship between components is embodied in the identifier metadata.
• FRSM-02.3: Every component to granularity level GL3 (module) has its own unique identifier.

FRSM-03: Versions Identifiers

Does each version of the software have a unique identifier?

• FRSM-03.1: Each version of the software has a different identifier.
• FRSM-03.2: Relations between the versions are included in the identifier metadata.
• FRSM-03.3: The version number is included in the identifier metadata.

FRSM-04: Purpose Metadata

Does the software include descriptive metadata which helps define its purpose?

• FRSM-04.1: The software includes a README or other file which includes the software title and description.
• FRSM-04.2: The software includes other descriptive metadata such as domain, funder, programming language, date created, and keywords.
• FRSM-04.3: The metadata is contained in a format such as CodeMeta or ProjectObjectModel that enables full machine actionability.

FRSM-05: Status Metadata

Does the software include development metadata which helps define its status?

• FRSM-05.1: The software includes metadata for contact or support in the README or other intrinsic metadata file according to community standards.
• FRSM-05.2: The software includes metadata for development status, links to documentation.
• FRSM-05.3: The metadata is contained in a format such as CodeMeta or ProjectObjectModel that enables full machine-actionability.

FRSM-06: Contributors Roles

Does the software include metadata about the contributors and their roles?

• FRSM-06.1: The software includes metadata about the contributors.
• FRSM-06.2: The software includes citation metadata that includes all contributors and their roles. This includes ORCIDs when contributors have them.
• FRSM-06.3: Does the citation metadata include the proportional credit attributed to each contributor?

FRSM-07: Identifier Metadata

Does the software metadata include the identifier for the software?

• FRSM-07.1: Does the software include an identifier in the README or citation file?
• FRSM-07.2: Does the identifier resolve to the same instance of the software?
• FRSM-07.3: N/A

FRSM-08: Metadata Record

Does the software have a publicly available, openly accessible and persistent metadata record?

• FRSM-08.1: A metadata record for the software is present on an infrastructure that guarantees persistence.
• FRSM-08.2: The persistent metadata record is available through public search engines. The metadata has a globally unique and persistent identifier.
• FRSM-08.3: The persistent metadata record is available through multiple, cross-referenced infrastructures.

FRSM-09: Code Repository

Is the software developed in a code repository / forge that uses standard communications protocols?

• FRSM-09.1: The code repository / forge can be accessed using the identifier via a standardised protocol.
• FRSM-09.2: If authentication or authorisation are required, these are supported by the communication protocols and the repository / forge.
• FRSM-09.3: N/A

FRSM-10: Data Formats

Are the formats used by the data consumed or produced by the software open and a reference provided to the format?

• FRSM-10.1: The documentation describes the data formats used.
• FRSM-10.2: The data formats used are open.
• FRSM-10.3: A reference to the schema is provided.

FRSM-11: Open APIs

Does the software use open APIs that support machine-readable interface definition?

• FRSM-11.1: The software provides documented APIs.
• FRSM-11.2: The APIs are open (freely accessible).
• FRSM-11.3: The APIs include a machine-readable interface definition.

FRSM-12: References Objects

Does the software provide references to other objects that support its use?

• FRSM-12.1: N/A
• FRSM-12.2: The software metadata includes machine-readable references to articles describing the software, articles demonstrating use of the software, or to the data it uses.
• FRSM-12.3: N/A

FRSM-13: Usage Requirements

Does the software describe what is required to use it?

• FRSM-13.1: The software has build, installation and/or execution instructions.
• FRSM-13.2: Dependencies are provided in a machine-readable format and the building and installation of the software is automated.
• FRSM-13.3: N/A

FRSM-14: Test Cases

Does the software come with test cases to demonstrate it is working?

• FRSM-14.1: Tests and data are provided to check that the software is operating as expected.
• FRSM-14.2: Automated unit and system tests are provided.
• FRSM-14.3: Code coverage / test coverage is reported.

FRSM-15: License in Source Code

Does the software source code include licensing information for the software and any bundled external software?

• FRSM-15.1: The software includes its LICENCE file.
• FRSM-15.2: The source code includes licensing information for all components bundled with that software.
• FRSM-15.3: The software licensing information is in SPDX format.

FRSM-16: License in Metadata

Does the software metadata record include licensing information?

• FRSM-16.1: The identifier or metadata record includes licensing and copyright information.
• FRSM-16.2: N/A
• FRSM-16.3: The software licensing information is in SPDX format, or other machine-readable form.

FRSM-17: Provenance

Does the software include provenance information that describe the development of the software?

• FRSM-17.1: The software source code repository / forge includes a commit history.
• FRSM-17.2: The software source code repository links commits to issues / tickets.
• FRSM-17.3: The software project uses other tools to capture detailed machine readable provenance information.

Author

$FULLNAME <<$EMAIL>>