Repository navigation
docs: add the Zenodo DOI - #550
Conversation
Add the DOI badge and the concept DOI to the README Citation section and to CITATION.cff (doi and identifiers), as in foca-plugins. Closes #549 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011FSoqMUX3EU35poH13xMgG
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis documentation-only change adds the Zenodo concept DOI 10.5281/zenodo.23858158 to the README and CITATION.cff, including a badge, citation guidance, and version identifier metadata. No component, package, or documentation-app code is modified; CFF validation and release-script tests reportedly pass. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've reviewed your changes and they look great!
Linked issues
#549 docs: add the Zenodo DOI to README and CITATION · 2 of 3 met · 1 to check by hand
| # | Requirement | Status | Notes |
|---|---|---|---|
| 1 | Add the concept DOI to the README with a badge and citation guidance. | ✅ Met | The README adds a DOI badge and updates the Citation section with the DOI and Zenodo version guidance. |
| 2 | Add the DOI and an identifiers entry to CITATION.cff. | ✅ Met | CITATION.cff includes the DOI and a DOI identifier entry with a description. |
| 3 | Use the Zenodo concept DOI that resolves to the latest version after the v2.0.0-alpha.50 release. | 👀 Check by hand (external system) | Check on Zenodo that this DOI resolves to the latest version and that the record lists the version-specific DOI. |
Sourcery assessment
Needs a human reviewer. GitHub may use the new citation metadata to generate citations with this DOI; if it points to the wrong record, users could copy and publish incorrect references. Reverting removes it from future generated citations, but cannot recall references already used.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #550 +/- ##
=======================================
Coverage 70.89% 70.89%
=======================================
Files 23 23
Lines 5638 5638
Branches 190 190
=======================================
Hits 3997 3997
Misses 1636 1636
Partials 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Adds the Zenodo concept DOI 10.5281/zenodo.23858158 (always resolves to the latest version) after the v2.0.0-alpha.50 release, as in foca-plugins#47: DOI badge and Citation wording in the README, and doi plus an identifiers entry in CITATION.cff. The documentation app needs no change (it does not show citation text).
Light lane: docs and metadata only; no component or package code touched.
Verification:
Closes #549
🤖 Generated with Claude Code
https://claude.ai/code/session_011FSoqMUX3EU35poH13xMgG
Summary by Sourcery
Add Zenodo DOI metadata and README citation support for the project.
New Features:
Enhancements:
Documentation: