Skip to content

Add citation.cff (and potentially a zenodo.json) to the repository #167

@brendanreardon

Description

@brendanreardon

Feature description

We are now minting Zenodo DOIs for Cat-VRS Releases. Zenodo produces both version specific citations as well as a concept specific citation, which represents all versions and will always resolve to the latest version. @ahwagner enabled Zenodo on the repository and thus owns the Zenodo concept, and I used this script that he found to generate a DOI for the 1.0.0 release.

The Zenodo concept-specific citation for this repository is: https://zenodo.org/records/17093421. The Zenodo "button" for this citation can be added to Markdown with the following syntax

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17093422.svg)](https://doi.org/10.5281/zenodo.17093422)

Tasks involving this include:

  • Creating a citation.cff to store metadata of how the citation should be presented. We can add a preferred publication to this, such as the in progress Cat-VRS call to action or an eventual white paper describing the product.
  • Add the citation.cff and zenodo DOI for the home README.md

We may also want to consider adding a .zenodo.json file to the repository. While Zenodo extracts metadata from the repository automatically through a GitHub web hook, this file can override some parts of it. A use case may be wanting to cite GKS or GA4GH, instead of repository administrators. I'm inclined to not, since we use GitHub as the "home base" instead of Zenodo. Plus, other GKS repositories such as cat-vrs-python or vrs, don't.

Contribution

Yes, I can create a PR for this feature.

Metadata

Metadata

Labels

enhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions