[ENH] add CITATION.cff file #609
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Moritz-Alexander-Kern
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A
citation.cfffile contains metadata about a software project. It can be used to generate citations for Elephant and link it to other sources of information, such as repositories, archives, or DOI services.The
citation.cfffile can eventually replace the.zenodo.jsonfile, which is currently used to provide metadata for Zenodo.More information on the citation file format can be found here: https://citation-file-format.github.io/.
One of the current open issues with the citation.cff file is that it does not support specifying grants the project. This is a feature that is available in the
.zenodo.jsonfile and that is useful for acknowledging the financial support of the project. A related issue has been opened on the CFF GitHub repository: citation-file-format/citation-file-format#491