Add CITATION.cff #192
Merged
Add CITATION.cff #192
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
willGraham01
force-pushed
the
add-citation-file
branch
from
4b889b9
to
93326f3
Compare
alessandrofelder
approved these changes
Jan 30, 2024
There was a problem hiding this comment.
Looks good to me.
It might be worth making an (meta)issue for @adamltyson to double-check all the cff files once they exist, just to be sure?
If #191 goes in before this, this will need an update to the latest version and corresponding hash.
I can't tell if you've done this but let this be a reminder that you think you should, if you haven't yet.
|
I'll update brainglobe/BrainGlobe#61 with a list of our repos that we add CITATION.cffs to. Once the citation functionality goes into |
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.
Related to brainglobe/BrainGlobe#61, this update adds a
CITATION.cfffile to the repository..cffformat is explained and can be generated here.Amongst other things, this will mean that GitHub will provide citation information (and source code, should we want it!) when visiting the repository homepage.
Moreover, it moves us towards the objective of brainglobe/BrainGlobe#61 by adding a custom
citation-sentencefield. This is intended for our own internal use in abrainglobe-metacite()function, which can fetch the.cfffiles that are in our repositories.(If #191 goes in before this, this will need an update to the latest version and corresponding hash. It also depends on #191 implicitly, since this fixes the PANDAS warning that we are seeing in CI).