glass icon indicating copy to clipboard operation
glass copied to clipboard

Change `CITATION.md` to `CITATION.cff`

Open paddyroddy opened this issue 1 year ago • 7 comments

It's a dedicated file format designed to promote code as research https://citation-file-format.github.io, but can also promote papers using the preferred syntax

paddyroddy avatar Sep 10 '24 14:09 paddyroddy

I don't find .cff files at all useful, since no one in our field would know what to do with them. Let's do a .bib file with bibtex from ADS: https://ui.adsabs.harvard.edu/abs/2023OJAp....6E..11T/exportcitation

ntessore avatar Sep 12 '24 17:09 ntessore

The .cff format will enable copy-pastable citation in a dropdown menu on github, offering both APA and BibTex formats -

image

This has become a standard for software citations, but I'll also be happy to convert the .md file to a .bib file.

Saransh-cpp avatar Sep 13 '24 10:09 Saransh-cpp

That's pretty cool, but I would rather not lose the extra metadata from the ADS entry,

ntessore avatar Sep 13 '24 11:09 ntessore

Oh I see, .bib sounds good then!

Saransh-cpp avatar Sep 13 '24 13:09 Saransh-cpp

The .cff format will enable copy-pastable citation in a dropdown menu on github, offering both APA and BibTex formats - image

This has become a standard for software citations, but I'll also be happy to convert the .md file to a .bib file.

Wouldn't a CITATION.cff, which only refers to the paper, be useful to benefit from this GitHub feature? An easy way to get a citation that you might not get otherwise. Can always also include a paper citation in the README like this.

paddyroddy avatar Sep 17 '24 11:09 paddyroddy

Having a BibTex entry in the README and a .cff file to enable GitHub's feature sounds better imo. PyBaMM (BibTex in README, .cff file for GitHub) does the same too. I'll reopen this issue for more discussion.

Saransh-cpp avatar Sep 18 '24 09:09 Saransh-cpp

Discussed in meeting and will adapt to CITATION.cff

paddyroddy avatar Oct 03 '24 16:10 paddyroddy