-
Notifications
You must be signed in to change notification settings - Fork 128
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
Add CITATION.cff file #1700
Conversation
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. |
@victorlin might be worth creating issues in nextstrain/auspice and nextstrain/nextstrain.org, at a minimum? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
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. |
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).
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
2e65c87
to
ce291ae
Compare
preview:
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