Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 2.19 KB

02_citation.md

File metadata and controls

28 lines (18 loc) · 2.19 KB
title
Next step: Citation data

It is likely that your CITATION.cff currently doesn't pass validation. The error messages you get from the cffconvert GitHub Action are unfortunately a bit cryptic, but doing the following helps:

  • Check if the given-name and family-name keys need updating. If your family name has a name particle like von or van or de, use the name-particle key; if your name has a suffix like Sr or IV, use name-suffix. For details, refer to the schema description: https://github.com/citation-file-format/citation-file-format
  • Update the value of the orcid key. If you do not have an orcid yet, you can get one here https://orcid.org/.
  • Add more authors if needed
  • Update date-released using the YYYY-MM-DD format.
  • Update the doi key with the conceptDOI for your repository (see https://help.zenodo.org for more information on what a conceptDOI is). If your project doesn't have a DOI yet, you can use the string 10.0000/FIXME to pass validation.
  • Verify that the keywords array accurately describes your project.

Afterwards, the cffconvert GitHub Action should be green.

To make sure services like Zenodo and the Research Software Directory can keep your citation data up to date, the cffconvert GitHub Action checks the following:

  1. Whether your repository includes a CITATION.cff file.

    By including this file, authors of the software can receive credit for the work they put in.

  2. Whether your CITATION.cff is valid YAML.

    Visit http://www.yamllint.com/ to see if the contents of your CITATION.cff are valid YAML.

  3. Whether your CITATION.cff adheres to the schema (as listed in the CITATION.cff file itself under key cff-version).

    The Citation File Format schema can be found here, along with an explanation of all the keys. You're advised to use the latest available schema version.