Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CITATION.cff file #2598

Open
robyngit opened this issue Jan 30, 2025 · 2 comments
Open

Add CITATION.cff file #2598

robyngit opened this issue Jan 30, 2025 · 2 comments
Labels
documentation Creating and enhancing app documentation
Milestone

Comments

@robyngit
Copy link
Member

GitHub supports citation metadata via a CITATION.cff file. To improve discoverability and compatibility with citation tools, we should add a CITATION.cff file that references the existing DOI.

GitHub uses this file to show a "Cite this repository" button like so:

Example showing a repo citation button

This file could also be used to help automate the release workflow (#2593) - it would give us a clean way to get the current DOI to download the existing datacite xml to update. In turn, the automated workflow could also update the CITATION.cff on new releases.

@robyngit robyngit added the documentation Creating and enhancing app documentation label Jan 30, 2025
robyngit added a commit that referenced this issue Jan 31, 2025
@robyngit robyngit added this to the 2.33.0 milestone Jan 31, 2025
@mbjones
Copy link
Member

mbjones commented Feb 3, 2025

Thanks, this is a great idea. The CFF metadata spec is a subset of the metadata in the CodeMeta (https://codemeta.github.io) software metadata spec that we have helped develop, and which GitHub originally supported for citation metadata. If Gtihub still supports codemeta.json for citation metadata for software, I'd prefer to use that format as it is schema.org compatible and is the direction that other groups like scicodes.net have adopted. Can you take a look at that as well when implementing here please?

@robyngit
Copy link
Member Author

@mbjones too bad, it looks like GitHub. doesn't support codemeta.json:

Other citation files

The GitHub citation feature will also detect a small number of additional files that are often used by communities and projects to describe how they would like their work to be cited.

GitHub will link to these files in the Cite this repository prompt, but will not attempt to parse them into other citation formats.

Note these are case-insensitive and must be in the root of the repository
CITATION
CITATIONS
CITATION.bib
CITATIONS.bib
CITATION.md
CITATIONS.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Creating and enhancing app documentation
Projects
None yet
Development

No branches or pull requests

2 participants