docs: Add CITATION.cff for GitHub citation support (#25)#30
Merged
Conversation
## Summary Closes #25 — adds `CITATION.cff` to the repo root to enable GitHub's native "Cite this repository" button, making it easy for researchers to cite VibeBench correctly in their papers. ## File Added **`CITATION.cff`** ```yaml cff-version: 1.2.0 message: "If you use VibeBench, please cite it as below." authors: - family-names: Arif given-names: Muktadir orcid: "https://orcid.org/0009-0005-6412-8980" title: "VibeBench: An Automated Framework for the Holistic Evaluation of LLM-Generated Code" version: 1.2.0 doi: 10.5281/zenodo.18758578 date-released: 2026-03-09 url: "https://github.com/umayer16/VIBEBENCH" ``` ## Why This Matters - GitHub automatically detects `CITATION.cff` and surfaces a **"Cite this repository"** button on the repo page - Researchers can export the citation in APA, BibTeX, and other formats with one click - JOSS reviewers expect software to be citable — this makes the citation metadata machine-readable and formally versioned against the Zenodo DOI Closes #25 ``` --- **Branch name:** ``` docs/issue-25-add-citation-cff ``` **Commit message:** ``` docs: add CITATION.cff for GitHub citation support (#25)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Closes #25 — adds
CITATION.cffto the repo root to enable GitHub's native "Cite this repository" button, making it easy for researchers to cite VibeBench correctly in their papers.File Added
CITATION.cff