Replace CITATION.bib with CITATION.cff for better GitHub integration #272
Conversation
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? |
|
Hi @EwoutH, I'm trying to make some changes to the citation files. Is it possible for you to enable maintainer edits for this PR? |
|
This PR is on a mesa-geo branch, so you should already be able to: https://github.com/projectmesa/mesa-geo/tree/citation_cff Totally forgot it by the way, so thanks for picking it up! |
|
Got it. Thanks!! |
wang-boyu
force-pushed
the
citation_cff
branch
3 times, most recently
from
6d32a86 to
bbfcb05
Compare
|
Should be ready now. @EwoutH would you like to take a look at this when you have time before merging? |
|
Awesome, thanks! |
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: