Skip to content

feat: add CITATION.cff and .zenodo.json for academic citation support#2291

Merged
mnriem merged 3 commits intogithub:mainfrom
MannXo:feat/zenodo-citation
Apr 21, 2026
Merged

feat: add CITATION.cff and .zenodo.json for academic citation support#2291
mnriem merged 3 commits intogithub:mainfrom
MannXo:feat/zenodo-citation

Conversation

@MannXo
Copy link
Copy Markdown
Contributor

@MannXo MannXo commented Apr 21, 2026

Summary

  • Adds CITATION.cff (Citation File Format 1.2.0) — GitHub natively surfaces a "Cite this repository" button once this file is on main, no further setup needed.
  • Adds .zenodo.json — Zenodo reads this to pre-fill the DOI metadata record. Once a maintainer enables the integration at zenodo.org (Settings → GitHub → enable spec-kit), Zenodo will mint a DOI on the next release automatically.

Closes #2269

What maintainers still need to do

  1. Go to zenodo.org and sign in via GitHub.
  2. Under GitHub → Settings, enable the spec-kit repository.
  3. On the next GitHub release, Zenodo will archive the repo and mint a DOI.

The CITATION.cff file works independently of Zenodo — GitHub will show the cite button as soon as this PR merges.

Manual test results

No slash commands are affected by this change (metadata files only, no scripts or templates modified).

Agent: Claude Code (claude-sonnet-4-6) | OS/Shell: Windows 11 / bash

Command tested Notes
pytest tests/ -q 1394 passed, 112 skipped, 3 pre-existing symlink failures on Windows (WinError 1314 — not introduced by this PR)

AI disclosure

This PR was written with Claude Code (Anthropic) assistance. The file contents, authorship choices, and metadata values were reviewed and approved by the human contributor before submission.

Adds a Citation File Format file (CITATION.cff) so GitHub surfaces a
native "Cite this repository" button, and a .zenodo.json metadata file
so Zenodo can pre-fill the DOI record once a maintainer enables the
integration at zenodo.org.

Closes github#2269
@MannXo MannXo requested a review from mnriem as a code owner April 21, 2026 13:19
Copilot AI review requested due to automatic review settings April 21, 2026 13:19
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds standard citation metadata files so the repository can be cited directly via GitHub’s “Cite this repository” UI and optionally integrated with Zenodo for DOI minting on releases.

Changes:

  • Added CITATION.cff (CFF 1.2.0) for GitHub-native citation metadata.
  • Added .zenodo.json to prefill Zenodo deposit metadata for DOI creation on release.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
CITATION.cff Introduces citation metadata for GitHub’s citation feature (title/authors/version/date/keywords).
.zenodo.json Adds Zenodo metadata (title/description/creators/license/keywords/related identifier) for DOI deposits.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .zenodo.json Outdated
Comment thread .zenodo.json Outdated
Comment thread .zenodo.json Outdated
Comment thread CITATION.cff Outdated
Comment thread CITATION.cff Outdated
Copy link
Copy Markdown
Collaborator

@mnriem mnriem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please address all feedback, both mine and Copilot feedback

- Fix 'a specify CLI' -> 'the Specify CLI' in both files
- Broaden description to include extensions, presets, and workflows
- Remove empty orcid fields from .zenodo.json creators
- Update date-released to 2026-04-17 (actual 0.7.3 release date)
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 1

Comment thread CITATION.cff Outdated
@mnriem mnriem self-requested a review April 21, 2026 13:43
mnriem
mnriem previously approved these changes Apr 21, 2026
@mnriem mnriem merged commit 52afbea into github:main Apr 21, 2026
@mnriem
Copy link
Copy Markdown
Collaborator

mnriem commented Apr 21, 2026

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: link to zenodo to ease citation of the spec-kit in "sciency" papers

3 participants