Skip to content

Add Zenodo DOI badge, citation metadata, and identifiers#325

Merged
igerber merged 2 commits intomainfrom
docs/zenodo-doi-badge
Apr 18, 2026
Merged

Add Zenodo DOI badge, citation metadata, and identifiers#325
igerber merged 2 commits intomainfrom
docs/zenodo-doi-badge

Conversation

@igerber
Copy link
Copy Markdown
Owner

@igerber igerber commented Apr 18, 2026

Summary

  • Zenodo minted DOIs for diff-diff when v3.1.3 was released:
    • Concept DOI (always-latest): `10.5281/zenodo.19646175`
    • v3.1.3 versioned DOI: `10.5281/zenodo.19646176`
  • Wire the concept DOI into the README badge row and BibTeX citation block. Use concept DOI in user-facing surfaces so the citation stays valid across future releases without further edits.
  • Upgrade the BibTeX author from `{{diff-diff contributors}}` to `Gerber, Isaac` to match `CITATION.cff`'s canonical authorship and ORCID.
  • Add `doi:` top-level field to `CITATION.cff` (so GitHub's "Cite this repository" button and other CFF parsers pick up the concept DOI) and an `identifiers:` list with concept + versioned DOIs and human-readable descriptions for each.
  • Docs audit of `paper.md`, `docs/`, and the llms guides found no stale "no DOI" or "pending" language to clean up.

Methodology references

  • N/A — release metadata only; no estimator, math, or inference changes.

Validation

  • No automated test coverage for CITATION.cff content; manual inspection confirms CFF 1.2.0 schema compliance (top-level `doi:` + `identifiers:` list with `type: doi`, `value`, `description` per spec).
  • README badge URL verified against Zenodo's canonical badge pattern (`https://zenodo.org/badge/DOI/.svg`) and resolves to the concept record.
  • DOI values cross-checked by pulling the Zenodo record via `GET /api/records/19646176` (version `v3.1.3`, publication date `2026-04-18`, conceptdoi matches).

Security / privacy

  • Confirm no secrets/PII in this PR: Yes

Generated with Claude Code

@igerber @claude
Add Zenodo DOI badge, citation metadata, and identifiers
717c7a0 
Zenodo minted DOIs for diff-diff when v3.1.3 was released:
- concept DOI: 10.5281/zenodo.19646175 (always-latest)
- v3.1.3 DOI: 10.5281/zenodo.19646176

Wires the concept DOI into the README badge row and the BibTeX citation
block; adds concept + versioned DOIs to CITATION.cff via `doi:` (top-level,
for tools like GitHub's "Cite this repository" button) and `identifiers:`
(for explicit concept-vs-versioned distinction). Also updates the BibTeX
author from "diff-diff contributors" to "Gerber, Isaac" to match
CITATION.cff's canonical authorship.

Docs audit (paper.md, docs/, llms guides) found no stale "no DOI" or
"pending" placeholder language to clean up.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 18, 2026

Overall Assessment

Looks good. No unmitigated P0/P1 findings; highest issue is a P3 informational metadata-consistency item.

Executive Summary

  • No estimator, weighting, variance/SE, identification, or default-behavior code is touched. The diff is limited to CHANGELOG.md, CITATION.cff, and README.md, so the Methodology Registry has no affected method entry to cross-check.
  • The new DOI badge and the CITATION.cff doi/identifiers additions are internally consistent on the concept and versioned DOI values.
  • P3 informational: the author-name standardization is partial. README/CFF now present Gerber, Isaac, while other public metadata surfaces still say diff-diff contributors.
  • The statistical edge-case checklist is not implicated because no runtime code paths or inference helpers changed.
  • No security or performance concerns were introduced.

Methodology

No findings. This PR does not modify estimator implementations, math, weighting, variance/SE logic, identification assumptions, or default behaviors.

Code Quality

No findings. Within the changed files, the DOI values and release metadata are consistent.

Performance

No findings. No executable paths changed.

Maintainability

  • Severity: P3. Impact: README’s new citation author at README.md:L3068-L3075 now diverges from other public metadata surfaces that still advertise diff-diff contributors in pyproject.toml:L12-L14, docs/conf.py:L17-L18, and docs/_templates/layout.html:L18. Downstream users and tooling can now see different authorship depending on which metadata surface they read. Concrete fix: Either align those surfaces to the same author policy, or add a brief note clarifying that citation authorship intentionally differs from package/documentation authorship.

Tech Debt

No findings. This docs/metadata-only PR does not need a new TODO.md deferral.

Security

No findings. The changes only add public citation metadata and a DOI badge.

Documentation/Tests

No findings. I did not see a documentation defect in the changed files beyond the authorship-consistency note above.

@igerber @claude
Address CI review P3: document citation-vs-package authorship split
9eac7d6 
Reviewer flagged that README BibTeX (Gerber, Isaac) and CITATION.cff now
diverge from pyproject.toml / docs/conf.py / layout.html, which still say
"diff-diff contributors." Of the reviewer's two suggested fixes (align all
surfaces, or document the intentional split), documenting is the right
move — package metadata using a collective name is a standard OSS
convention that acknowledges Wenli Xu and future contributors without
churning pyproject.toml on every new PR. Academic citation using
individual authors with ORCIDs is a separate scholarly convention.

Adds a brief "Note on authorship" after the BibTeX block in README.md's
Citing section, pointing readers to CONTRIBUTORS.md for the collective
list.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@igerber
Copy link
Copy Markdown
Owner Author

igerber commented Apr 18, 2026

/ai-review

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 18, 2026

🔁 AI review rerun (requested by @igerber)

Head SHA: 9eac7d66ff5fed6bcfd40e9fbcf9dc425d7efe2a

Overall Assessment

✅ Looks good

Executive Summary

Methodology

No findings. The PR does not modify any estimator or any behavior covered by docs/methodology/REGISTRY.md.

Code Quality

No findings. The changed metadata surfaces are internally consistent, and the new CITATION.cff structure is syntactically valid YAML.

Performance

No findings. No executable path changed.

Maintainability

  • Severity: P3 (mitigated/resolved).
  • Impact: The earlier authorship-consistency concern is now documented explicitly rather than left as unexplained drift between scholarly citation metadata and package/docs metadata.
  • Concrete fix: Already implemented in README.md:L3079-L3083; no further action required.

Tech Debt

No findings. No new deferred work needs TODO.md tracking.

Security

No findings. The added DOI/ORCID/citation metadata is public release metadata and introduces no secret-bearing content.

Documentation/Tests

No findings. For a docs/metadata-only PR, the updated README citation guidance plus a parseable CITATION.cff is sufficient.

@igerber igerber added the ready-for-ci Triggers CI test workflows label Apr 18, 2026
@igerber igerber merged commit 4e1c086 into main Apr 18, 2026
1 of 2 checks passed
@igerber igerber deleted the docs/zenodo-doi-badge branch April 18, 2026 22:31
@igerber igerber mentioned this pull request Apr 20, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

ready-for-ci Triggers CI test workflows

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@igerber