Add CITATION.cff for citation metadata - #5
Open
KardelRuveyda wants to merge 1 commit into
Open
Conversation
Enables GitHub's 'Cite this repository' button. Users can then export BibTeX/APA/RIS in one click for both the software and the bioRxiv preprint. Author list intentionally minimal; please amend with full list before merging.
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
Adds a
CITATION.cfffile (Citation File Format v1.2.0) so that the repository can be cited via GitHub's built-in "Cite this repository" feature.Why
What it looks like
After merge, a "Cite this repository" entry will appear in the right sidebar of the repo, opening a popup with ready-to-copy APA and BibTeX citations pointing to the bioRxiv preprint (DOI:
10.1101/2024.08.18.608300).I verified this on my fork — the button renders correctly and produces valid output.
Notes for the maintainer
A few intentional choices that you may want to refine before merging:
year: 2024is taken from the bioRxiv submission date encoded in the DOI prefix. Please update if a newer revision exists.preferred-citationblock can be updated with the final journal name, volume, pages, and DOI.Happy to amend any of the above in this PR if you share the details — or feel free to edit directly (I left "Allow edits by maintainers" enabled).
Thanks for the great work on MouseMapper! 🐭