Add CITATION.cff for GBasis journal reference #225
+56
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marco-2023
requested changes
Jan 21, 2026
Contributor
marco-2023
left a comment
marco-2023
left a comment
There was a problem hiding this comment.
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.
Author
|
Hi! Thanks for the review. I’ve now added the citation explicitly to website/intro.md as requested. Please take another look. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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