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-07] Does the software metadata include the identifier for the software? #8

Open
karacolada opened this issue Nov 10, 2023 · 1 comment
Labels
enhancement New feature or request good first metric Good for newcomers

Comments

@karacolada
Copy link
Member

karacolada commented Nov 10, 2023

D5.2 p16+p26

Detailed Description

Software should include its identifier to make it easier to be cited and indexed.

Domain-agnostic comments

There are several common places for identifier metadata to be found, including README files, CodeMeta or CFF files. The choice of location may depend on community standards.

CESSDA comments

The Zenodo DOI representing all versions will always resolve to the latest version in Zenodo.

CESSDA uses Citation File Format, which can include a reference to the software identifier.

Context

F3: Metadata clearly and explicitly include the identifier of the software they describe.
R3: Software meets domain-relevant community standards.

Possible Implementation

domain-agnostic

requirements software source code, software identifier
method Check if the software includes its own software identifier, and that the identifier resolves to that software.
essential Does the software include an identifier in the README or citation file?
important Does the identifier resolve to the same instance of the software?
useful n/a

CESSDA

requirements software source code
method Check that README and CITATION files exist and include the DOI for the corresponding software release.
essential The README file includes the DOI that represents all versions in Zenodo.
important The CITATION.cff file included in the root of the repository includes the appropriate DOI for the corresponding software release in Zenodo.
useful n/a
@karacolada karacolada added the enhancement New feature or request label Nov 10, 2023
@karacolada karacolada added the good first metric Good for newcomers label May 29, 2024
@karacolada
Copy link
Member Author

Extend evaluator for inclusion of data identifier:

class FAIREvaluatorDataIdentifierIncluded(FAIREvaluator):

M0nje added a commit to M0nje/fuji that referenced this issue Sep 12, 2024
M0nje added a commit to M0nje/fuji that referenced this issue Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first metric Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant