📝 Add CITATION.cff - #35
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a root-level CITATION.cff so GitHub and citation tooling (e.g., cffconvert/Zenodo) can automatically render and export canonical citation metadata for warpkit, instead of relying on prose-only guidance in the README/LICENSE.
Changes:
- Introduces
CITATION.cffin CFF 1.2.0 format describing the software (type: software) and its authors. - Adds a
preferred-citationentry for the MEDIC paper with expanded bibliographic metadata and the full author list.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Adds a
CITATION.cffat the repo root so GitHub renders a "Cite this repository"button and tools like Zenodo/cffconvert can emit BibTeX/APA/EndNote automatically.
Previously the citation only existed as prose in
README.mdandLICENSE.Changes
CITATION.cff(CFF 1.2.0),type: software.authors— the software authors, mirroring the README "Authors" section(Andrew N. Van, Vahdeta Suljic). Andrew is listed first to match
LICENSE's"Authored by" line and
[project].authorsinpyproject.toml.preferred-citation— the MEDIC paper astype: article, with the complete33-author list (the README/LICENSE prose truncates at "et al."), plus journal,
year, volume, article number, ISSN, and DOI.
on
10.1162/IMAG.a.1262rather than typed by hand.license-urlpoints atLICENSEinstead of an SPDXlicenseidentifier —warpkit's non-commercial WashU license has no SPDX ID, and CFF's
licensefield only accepts SPDX enums.
Verification
uvx cffconvert --validate→ Citation metadata are valid according to schema version 1.2.0.uvx cffconvert -f apalikerenders cleanly.pre-commit run --files CITATION.cffpasses (codespell clean).Not CI-relevant: no build, packaging, or wheel-matrix impact.