Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support for CITATION.cff aka citation files from GitHub #3003

Open
SamuelLarkin opened this issue Jun 21, 2024 · 4 comments · May be fixed by #3103
Open

Support for CITATION.cff aka citation files from GitHub #3003

SamuelLarkin opened this issue Jun 21, 2024 · 4 comments · May be fixed by #3103
Assignees
@l-armstrong
Labels
good first issue Good for newcomers syntax-request

Comments

@SamuelLarkin
Copy link

SamuelLarkin commented Jun 21, 2024 •
edited
Loading

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
@SamuelLarkin SamuelLarkin added the feature-request New feature or request label Jun 21, 2024
@eth-p
Copy link
Collaborator

eth-p commented Jun 21, 2024

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.

@keith-hall keith-hall added good first issue Good for newcomers syntax-request and removed feature-request New feature or request labels Jun 21, 2024
@l-armstrong
Copy link

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

@keith-hall
Copy link
Collaborator

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
Copy link

Great, thank you!

@Ugzuzg Ugzuzg linked a pull request Oct 13, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@l-armstrong l-armstrong

Labels
good first issue Good for newcomers syntax-request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add syntax mapping for CITATION.cff Ugzuzg/bat
4 participants
@SamuelLarkin @keith-hall @eth-p @l-armstrong