Open
Conversation
set up a standard vs extended citation also adds references as a key in Zenodo metadata template, with citation pointer recommending use there
used for citation CFF templates
include examples and exlanations for keys
Move preferred-citation notes to tab where it's included
…ranch validator tool checks yaml, not citation cff format
hlapp
approved these changes
Apr 28, 2026
Member
hlapp
left a comment
There was a problem hiding this comment.
LGTM.
One comment re: wording to perhaps consider: That we generally want to ask people to cite both software and paper (if there is a paper) is an institutional practice we chose. But prioritizing the paper citation can also be a choice, which can result in actually wanting the paper citation to show up on the sidebar on GitHub (and perhaps including the code citation BibTeX in the README instead).
I don't have a good suggestion for how to convey this being a choice when instantiating the template, and of course there are a variety of reasons why code as a first-class citizen in citation networks should be promoted. So maybe this is best deferred to considering at a later time.
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
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.
I endeavored to simplify the
CITATION.cfftemplate as follows:markdown_extensionconfig in themkdocs.yaml..zenodo.jsonpaired with the citation file.yaml; it doesn't guarantee citation formatting.I also added the "references" key to the
.zenodo.jsontemplate for completeness.Closes #64.