manifesto.md

Conventionv1.2.0Release Hygiene

Citation File Format (CFF)

A CITATION.cff file in the root of a repository that gives human- and machine-readable citation metadata for software or a dataset, in YAML.

Canonical text: https://citation-file-format.github.io/, read against version 1.2.0. In use on this site: github.com/manifesto-md/manifesto.md/blob/main/CITATION.cff.

The format

  1. CITATION.cff files are plain text files with human- and machine-readable citation information for software (and datasets).
  2. Code developers can include them in their repositories to let others know how to correctly cite their software.
  3. Copy and paste the example into the root of your code repository, and adapt the information to your software.
  4. The file must be named CITATION.cff (note the capitalization) and be valid YAML 1.2.
  5. The keys cff-version, message, title and authors are required.
  6. The type of the work that is being described by this CITATION.cff file is software or dataset; the default is software.
  7. preferred-citation is a reference to another work that should be cited instead of the software or dataset itself.
  8. references are reference(s) to other creative works, for example to make visible the work that your own work builds on.
  9. When there are multiple licenses, it is assumed their relationship is OR, not AND.
  10. If you publish your software in an archive or registry, they (or their systems) can re-use the citation metadata; GitHub, Zenodo and Zotero read the file.

Facts

Maintainer
Stephan Druskat and Jurriaan H. Spaaks
Repository
https://github.com/citation-file-format/citation-file-format
Licence of the text
CC BY 4.0
Status of the text
stable
Listing
listed, not yet claimed

Read with

Badge

manifesto.md: listed

[![manifesto.md](https://img.shields.io/endpoint?url=https://manifesto.md/badge/citation-cff.json)](https://manifesto.md/citation-cff/)

Maintainers claim a listing with a pull request setting listing: claimed, or a yes on the listing issue.