Conversation
Without CITATION.cff there is no machine-readable way to cite this package, and GitHub shows no "Cite this repository" button, so anyone referencing it in a paper has to improvise. The fields are taken from the package itself: title and version from pyproject.toml, licence from the repository, release date from the latest release, and keywords from those already declared.
|
This branch has not been deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What this adds
A
CITATION.cffso the package can be cited properly.GitHub reads this file and shows a Cite this repository button on the repository page, offering APA and BibTeX.
Without it there is no machine-readable citation, and anyone referencing this package in a paper has to improvise
one.
Where the content came from
Nothing here is hand-written:
title,abstract,versionandkeywords— frompyproject.tomlonmainlicense— the repository's SPDX identifierdate-released— the latest GitHub releaserepository-code/url— the repository and its documentation siteVerification
Validated against the Citation File Format 1.2 schema with
cffconvert.Follow-up
This pairs with a Zenodo DOI: connecting the repository to Zenodo mints a DOI per release, which can then be added
to this file as
doi:and cited directly. Not part of this change.