Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
karacolada opened this issue Nov 10, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@karacolada
Copy link
Member

karacolada commented Nov 10, 2023

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 karacolada added the enhancement New feature or request label Nov 10, 2023
@karacolada
Copy link
Member Author

karacolada commented Jan 18, 2024

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

@karacolada
Copy link
Member Author

Extend data provenance evaluator:

class FAIREvaluatorDataProvenance(FAIREvaluator):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant