Repository navigation
Add CITATION.cff - #1533
Open
gonzalocasas wants to merge 1 commit into
Open
Add CITATION.cff#1533gonzalocasas wants to merge 1 commit into
gonzalocasas wants to merge 1 commit into
Conversation
Gives GitHub's "Cite this repository" and Zenodo proper citation metadata. Without it, Zenodo builds the author list from GitHub contributors, which yields handles, surname-only entries and a duplicate. Authors follow AUTHORS.md; the DOI is the concept DOI that always resolves to the latest release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1533 +/- ##
==========================================
- Coverage 62.40% 62.38% -0.02%
==========================================
Files 208 208
Lines 22487 22487
==========================================
- Hits 14032 14028 -4
- Misses 8455 8459 +4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
chenkasirer
approved these changes
Oct 5, 2026
chenkasirer
left a comment
Member
There was a problem hiding this comment.
LGTM!
Just linking a related work on CT where CITATION.cff is the single-source-of-truth and a bunch of other places reference it.
gramaziokohler/compas_timber#832
One thing we found out: PyPi will ignore the list of authors in pyproject.toml if they all have an email and will just show the top one.
This branch has not been deployed
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.cffso that GitHub's Cite this repository button and Zenodo get proper citation metadata.At the moment the repository has no citation file, so Zenodo builds each release's author list from GitHub contributors. The 2.15.1 record (10.5281/zenodo.19115881) lists GitHub handles ("beverlylytle", "deviezeviking"), surname-only entries ("Li", "Rippmann") and Romana Rust twice.
AUTHORS.mdexactly, in its order: project lead, main developers, then contributors (38 people). Emails are left out.10.5281/zenodo.2594510, which always resolves to the latest release.versionordate-released, so the file doesn't go stale between releases. Zenodo adds the version itself.cffconvert --validate(schema 1.2.0).Once merged, the next release's Zenodo record should take its authors from this file. The "Cite COMPAS" block on the new compas.dev homepage will then use the same list.
What type of change is this?
Checklist
CHANGELOG.mdfile in theUnreleasedsection under the most fitting heading (e.g.Added,Changed,Removed).invoke test). (No code changes.)invoke lint). (No code changes.)🤖 Generated with Claude Code