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 for academic citations #13

Merged
merged 6 commits into from
Oct 22, 2023

Conversation

sugatoray
Copy link
Contributor

@sugatoray sugatoray commented Aug 25, 2021

Add a CITATION.cff file to enable github support for citations to software

This fixes a broken link to tutorial in the readme file. This closes #13.

Context

image

GitHub now supports (natively) defining citations to use software repositories on hosted on the platform. Alike the LICENSE file, in this case, you essentially add a CITATION.cff file (formatted as yaml) to the repository root. And that creates the citations feature for the repository: you can get it as bibtex or in APA style.

Useful Links

synodriver pushed a commit to synodriver/sqlmodel that referenced this pull request Jun 24, 2022
…n-kwarg

feat: addition of optional validate
@tiangolo tiangolo changed the title Create CITATION.cff 🛠️ Create CITATION.cff file Oct 22, 2023
@tiangolo tiangolo changed the title 🛠️ Create CITATION.cff file 🛠️ Add CITATION.cff file Oct 22, 2023
@tiangolo tiangolo changed the title 🛠️ Add CITATION.cff file 🛠️ Add CITATION.cff file for academic citations Oct 22, 2023
@tiangolo
Copy link
Owner

Great, thanks! 🚀

@tiangolo tiangolo merged commit 89c356c into tiangolo:main Oct 22, 2023
10 checks passed
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

2 participants