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

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Add CITATION.cff file #1700

merged 1 commit into from
Dec 10, 2024

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Dec 9, 2024

preview:

image

Description of proposed changes

CFF is a file format for citations. This adds a "Cite this repository" button on the GitHub repo homepage.

Values retrieved from the JOSS paper page.

Related issue(s)

nextstrain/public#11

Checklist

  • Automated checks pass
  • Check if you need to add a changelog message
  • Check if you need to add tests
  • Check if you need to update docs

@victorlin victorlin added the documentation Improvements or additions to documentation label Dec 9, 2024
@victorlin victorlin self-assigned this Dec 9, 2024
@genehack
Copy link
Contributor

genehack commented Dec 9, 2024

I was curious what this looked like in practice, so I found a repo that has a CITATION.cff file — look at the right hand column where the readme, license, code of conduct, etc. are listed.

@genehack
Copy link
Contributor

genehack commented Dec 9, 2024

@victorlin might be worth creating issues in nextstrain/auspice and nextstrain/nextstrain.org, at a minimum?

Copy link

codecov bot commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.31%. Comparing base (85ab802) to head (ce291ae).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1700   +/-   ##
=======================================
  Coverage   72.31%   72.31%           
=======================================
  Files          79       79           
  Lines        8271     8271           
  Branches     1691     1691           
=======================================
  Hits         5981     5981           
  Misses       2005     2005           
  Partials      285      285           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@huddlej
Copy link
Contributor

huddlej commented Dec 9, 2024

Thank you, @victorlin! This has been on the back of my mind since ~Jan 2021... 😄 Very cool to see it implemented this way, so I can use the same pattern for other projects.

@victorlin
Copy link
Member Author

@genehack

might be worth creating issues in nextstrain/auspice and nextstrain/nextstrain.org, at a minimum?

I chose this repo because it already had a citation snippet in the README. The other two don't. It seems easy enough to just create PRs for those repos, so I'll do that (citing the Nextstrain paper).

I was curious what this looked like in practice

There's a preview link at the top of this PR. Just added a screenshot too.

CFF is a file format for citations.¹ This adds a "Cite this repository"
button on the GitHub repo homepage.²

Values retrieved from the JOSS paper page.

¹ https://citation-file-format.github.io
² https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
@victorlin victorlin force-pushed the victorlin/add-citation-file branch from 2e65c87 to ce291ae Compare December 10, 2024 00:16
@victorlin victorlin merged commit d0251d3 into master Dec 10, 2024
32 checks passed
@victorlin victorlin deleted the victorlin/add-citation-file branch December 10, 2024 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants