Replace CITATION.bib with CITATION.cff for better GitHub integration #272
Conversation
This file contains 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
Replaced the existing `CITATION.bib` file with a `CITATION.cff` file to leverage GitHub's native citation support. The `CITATION.cff` file provides both human- and machine-readable citation metadata, allowing users to easily cite the repository in formats like APA and BibTeX directly from GitHub's "Cite this repository" feature. The new `CITATION.cff` includes: - Author details - Title, DOI, and URL - Book title and conference details - Keywords and abstract This change aligns with modern citation practices for software and academic works on GitHub.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
Hmmm I get this weird warning I can't seem to get rid of, while the CFF seems to be formatted correctly.
The issue might be that it isn't present on the main branch, but not sure. |
|
Thanks! There's a link to the removed .bib file in README. Shall we change it to point to the "Cite this repository" feature instead? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Replaced the existing
CITATION.bibfile with aCITATION.cfffile to leverage GitHub's native citation support. TheCITATION.cfffile provides both human- and machine-readable citation metadata, allowing users to easily cite the repository in formats like APA and BibTeX directly from GitHub's "Cite this repository" feature.The new
CITATION.cffincludes:This change aligns with modern citation practices for software and academic works on GitHub. See: