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.

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

Add CITATION.cff file #26213

Merged
merged 1 commit into from Jul 1, 2023
Merged

Add CITATION.cff file #26213

merged 1 commit into from Jul 1, 2023

Conversation

cgobat
Copy link
Contributor

@cgobat cgobat commented Jun 29, 2023

PR summary

Two years ago, in a9d5a89, the repository's BibTeX citation file was moved and renamed to be compatible with GitHub's new citation format. Building upon that, this PR adds a CITATION.cff file: CFF (citation file format) files are special YAML files with native GitHub support and direct integration with the "Cite this repository" feature. CFF is capable of providing incredibly rich metadata, and isn't LaTeX- or language-specific, so CFF files can easily be exported in a variety of popular citation formats.

As an example of such a file in use, see CITATION.cff in pandas-dev/pandas (though the one added in this PR contains even more detail!).

Because the CFF definition uses jsonschema, CFF files can be easily validated (e.g. using cffconvert, or through GitHub Actions, using dieghernan/cff-validator). A workflow to do this automatically when the file is altered has also been added, in .github/workflows/cff-validator.yml.

This may or may not replace the existing CITATION.bib—some further discussion about the role of that file is warranted prior to removal.

PR checklist

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@tacaswell
Copy link
Member

I am 👍🏻 on adding this file, but 👎🏻 on adding the validation workflow. This file is going to be effectively static so I do not anticipate there being a need re-validate that we have not messed the file up.

@tacaswell tacaswell added this to the v3.8.0 milestone Jun 29, 2023
@cgobat
Copy link
Contributor Author

cgobat commented Jun 29, 2023

Thanks @tacaswell. I will remove the cff-validator.yml file from the workflows then.

@cgobat cgobat changed the title Add CITATION.cff file and validation workflow Add CITATION.cff file Jun 29, 2023
@tacaswell
Copy link
Member

@cgobat Are you comfortable squashing this to one commit?

@cgobat
Copy link
Contributor Author

cgobat commented Jun 29, 2023

Yep—however you want to do it is fine by me.

@tacaswell
Copy link
Member

Can you please squash it then :)

This commit is a squash of e0e3eb9, 4ea4002, 15c8fc2, 913db84, and 48cd9c9
@cgobat
Copy link
Contributor Author

cgobat commented Jun 29, 2023

Sure, done. Wasn't sure whether you were going to do it on your side as part of the merge operation.

@jklymak jklymak merged commit 9fdf6ad into matplotlib:main Jul 1, 2023
39 checks passed
@cgobat cgobat deleted the add-cff branch July 1, 2023 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants