4 ms·

One thing I’m missing on GitHub is support for providing a citation for a journal paper about the software, not the software itself. It’s common to see somethi

by avian 5y ago

One thing I’m missing on GitHub is support for providing a citation for a journal paper about the software, not the software itself. It’s common to see something like “if you use this code, please cite this paper” in README files. There are many reasons why people put this into their READMEs, but it mostly boils down to the fact that paper citations affect various metrics, while citations of a GitHub repo mostly don’t matter. The citation file format does include a field for providing a list of extended references, but it seems that GitHub doesn’t support that.

sdruskat 5y ago
This is something that you can do by providing a `preferred-citation` in a CITATION.cff file. This will be rendered on GitHub as the thing to cite. See the schema guide section about this here: https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#credit-redirection https://github.com/citation-file-format/citation-file-format....
- avian 5y ago
  Ah, interesting. Thanks! I was experimenting with the "references" key to see if it can do what I want and somehow missed that "preferred-citation" exists. Was this added after the initial GitHub announcement?
  - sdruskat 5y ago
    The agenda release and docs update came a few days later, yes. I think it might have been in the Gem already, albeit experimentally.
polm23 5y ago
I was a little surprised that wasn't the default usage model, but I followed the instructions and it showed up as expected. https://github.com/polm/fugashi https://github.com/polm/fugashi
- sdruskat 5y ago
  This is because CFF is mainly built to support the software citation principles [1], where it is argued (rightly so, if you ask me) that software is important enough to be cited in its own right. Also, there will likely be no new paper for each version of software, so if you want to cite the version you have used in your work (e.g. towards reproducibility), the paper may be useless. [1]: https://doi.org/10.7717/peerj-cs.86 https://doi.org/10.7717/peerj-cs.86

by avian 5y ago

sdruskat 5y ago

This is something that you can do by providing a `preferred-citation` in a CITATION.cff file. This will be rendered on GitHub as the thing to cite. See the schema guide section about this here: https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#credit-redirection https://github.com/citation-file-format/citation-file-format....

avian 5y ago
Ah, interesting. Thanks! I was experimenting with the "references" key to see if it can do what I want and somehow missed that "preferred-citation" exists. Was this added after the initial GitHub announcement?
- sdruskat 5y ago
  The agenda release and docs update came a few days later, yes. I think it might have been in the Gem already, albeit experimentally.

polm23 5y ago

I was a little surprised that wasn't the default usage model, but I followed the instructions and it showed up as expected. https://github.com/polm/fugashi https://github.com/polm/fugashi

sdruskat 5y ago
This is because CFF is mainly built to support the software citation principles [1], where it is argued (rightly so, if you ask me) that software is important enough to be cited in its own right. Also, there will likely be no new paper for each version of software, so if you want to cite the version you have used in your work (e.g. towards reproducibility), the paper may be useless. [1]: https://doi.org/10.7717/peerj-cs.86 https://doi.org/10.7717/peerj-cs.86