Support for CITATION.cff aka citation files from GitHub

[SamuelLarkin]

Hi, I would like to suggest supporting .cff files which are the file format for GitHub citation (CITATION.cff). According to Citation File Format (CFF),

Citation File Format is a human- and machine-readable file format in [YAML 1.2](http://www.yaml.org/spec/1.2/spec.html) which provides citation metadata for software.

cff Example

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github-linguist/linguist"

Resources

• What is a CITATION.cff file?
• The Citation File Format lets you provide citation metadata for software or datasets in plaintext files that are easy to read by both humans and machines.
• About CITATION files on Github
• Sublime HQ - [YAML] Add CITATION.cff file extension

[eth-p]

A small note:

The citation file format schema mentions that they must be valid YAML 1.2.

This could be achieved by adding a syntax mapping from .cff to .yaml.

[l-armstrong]

Can I take a try at this? I'm new to the project and would like something to work on.

[keith-hall]

Sure 🙂 it may make sense to look at recent PRs adding syntax mappings to see how it has been done before, let us know if you need any pointers/help 🙂

[l-armstrong]

Great, thank you!