search

softwaresaved / fuji

FAIRsFAIR Research Data Object Assessment Service
MIT License
0 stars 4 forks source link

[Feature]: [FRSM-06] Does the software include metadata about the contributors and their roles? #7

Open karacolada opened 1 year ago

karacolada commented 1 year ago

D5.2 p16+p26

Detailed Description

Software should make it easy to recognise and credit all contributors.

Domain-agnostic comments

There are several common places for contributor metadata to be found, including README files, CodeMeta or CFF files, in the code repository metadata, or in the software identifier metadata. It may also be directly embedded in software source code files. Criteria for which roles are included is normally defined by the community.

CESSDA comments

Authorship criteria should follow the CESSDA Publication Policy & Procedures (CESSDA, 2020). CESSDA uses Citation File Format for recording authorship, e.g. CDC-Searchkit citation.

Context

F2: Software is described with rich metadata. R3: Software meets domain-relevant community standards.

Possible Implementation

domain-agnostic
requirements Software source code, Software identifier
method Check if the software and/or software identifier has machine readable descriptive metadata associated with it that include contributors and roles.
essential The software includes metadata about the contributors
important The software includes citation metadata that includes all contributors and their roles. This includes ORCIDs when contributors have them.
useful Does the citation metadata include the proportional credit attributed to each contributor?

CESSDA
requirements Software source code, Software identifier
method Check that the CITATION and/or CONTRIBUTORS files exist and Zenodo metadata is present
essential A CITATION and/or CONTRIBUTORS files is present in the root of the repository.
important Author details (including ORCIDs) are present in the corresponding Zenodo record. ORCIDs are present for authors in the CITATION.cff file.
useful n/a
karacolada commented 10 months ago

Shouldn't this be R1, too? Metric 5 is, and this sounds similar.

karacolada commented 5 months ago

Extend data provenance evaluator: https://github.com/softwaresaved/fuji/blob/1778e730c80852f691e135a1b288bc2796914c46/fuji_server/evaluators/fair_evaluator_data_provenance.py#L12