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 #507

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ethanrd
Copy link
Member

@ethanrd ethanrd commented Feb 1, 2024

See issue #127 for discussion of these changes.

Release checklist

  • Update to use CF DOI once it is created.
  • [N/A] Authors updated in cf-conventions.adoc? Add in two places: on line 3 and under .Additional Authors in About the authors.
  • [N/A] Next version in cf-conventions.adoc up to date? Versioning inspired by SemVer.
  • [N/A] history.adoc up to date?
  • [N/A] Conformance document up to date?

@ethanrd
Copy link
Member Author

ethanrd commented Feb 1, 2024

I have tested this on a personal test repo (testCitation) if anyone wants to see what it looks like. See the "Cite this repository" pull down on right side of main repo page.

I kept it very minimal to not duplicate too much information. The CFF spec allows for lots of other information but I didn't find much that showed up in the automated citation output. I only added the first few authors. I didn't find an "et al" kind of feature so added "the CF Community" as the final author.

Here's the resulting citation in APA

Eaton, B., Gregory, J., Drach, B., Taylor, K., Hankin, S., & CF Community. NetCDF Climate and Forecast (CF) Metadata Conventions. https://doi.org/10.0000/00000

and in BibTeX

@misc{Eaton_NetCDF_Climate_and,
author = {Eaton, Brian and Gregory, Jonathan and Drach, Bob and Taylor, Karl and Hankin, Steve and {CF Community}},
doi = {10.0000/00000},
title = {{NetCDF Climate and Forecast (CF) Metadata Conventions}},
url = {https://cfconventions.org}
}

@ethanrd
Copy link
Member Author

ethanrd commented Feb 1, 2024

Waiting for CF DOI to be created before updating the CITATION.cff file and changing this PR from "Draft" to "Ready to review".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant