-
Notifications
You must be signed in to change notification settings - Fork 35
Add CITATION.cff for GBasis journal reference #225
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 for GBasis journal reference #225
Conversation
marco-2023
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @lipikaparida-web, thank you for the PR.
Adding a CITATION.cff file provides citation metadata that GitHub uses to populate the “Cite this repository” menu. However, it does not affect the generated website or Jupyter Book documentation, where the citation information is actually needed.
As a result, this PR is incomplete: the citation should also be surfaced explicitly in the documentation via a rendered reference entry in the website/intro.md file.
|
Hi! Thanks for the review. I’ve now added the citation explicitly to website/intro.md as requested. Please take another look. |
Updated citation information for GBasis library, including authors and BibTeX format.
CITATION.cff
Outdated
| title: "GBasis" | ||
| type: software | ||
| url: "https://github.com/theochem/gbasis" | ||
| license: "BSD-3-Clause" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GBasis is licensed under the GNU LESSER GENERAL PUBLIC LICENSE
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just a small change. I will add it myself
|
Thanks @lipikaparida-web for your PR. It now appears to be ready for merging. |
|
Thank you so much @marco-2023 for the review and merge! 🙏 |
Description
This PR adds a
CITATION.cfffile to the repository root so GitHub’s citation widget can automatically generate citations (BibTeX/APA) for GBasis.This makes the journal citation more visible and easier to export for users, complementing the citation information already present in the README.
Checklist
Type of Changes
Related
Refs #206