Skip to content

docs: add the Zenodo DOI - #550

Merged
uniqueg merged 1 commit into
devfrom
docs/doi-549
Nov 1, 2026
Merged

uniqueg merged 1 commit into
devfrom
docs/doi-549

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

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:

  • cffconvert --validate: valid (schema 1.2.0)
  • node scripts/release.js check 2.0.0-alpha.50: passes
  • node --test scripts/release.test.js: 25 pass, 0 fail

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:

  • Add a Zenodo DOI badge and citation guidance to the README.

Enhancements:

  • Add the Zenodo concept DOI and version identifiers to the citation metadata.

Documentation:

  • Document the concept DOI as the stable link to the latest release and provide version-specific citation context.

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
@uniqueg uniqueg added the type: docs Improvements or additions to documentation label Nov 1, 2026
@uniqueg
uniqueg marked this pull request as ready for review November 1, 2026 16:47
@uniqueg
uniqueg requested a review from anuragxxd as a code owner November 1, 2026 16:47
@sourcery-ai

sourcery-ai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This 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

Change Details Files
Add Zenodo DOI references to project citation metadata.
  • Record the concept DOI and version-specific identifier in the CFF metadata.
  • Keep the citation file compatible with schema 1.2.0 and release checks.
CITATION.cff
Document the Zenodo DOI and preferred citation workflow in the README.
  • Add a DOI badge linking to the concept DOI.
  • Explain that the concept DOI resolves to the latest Zenodo version and that version DOIs are available in the Zenodo record.
  • Link the citation guidance to CITATION.cff.
README.md

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@codecov

codecov Bot commented Nov 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.89%. Comparing base (e2f9fe2) to head (233fec0).
⚠️ Report is 1 commits behind head on dev.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@uniqueg
uniqueg merged commit 3b06f7a into dev Nov 1, 2026
28 of 37 checks passed
@uniqueg
uniqueg deleted the docs/doi-549 branch November 1, 2026 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add the Zenodo DOI to README and CITATION

1 participant