Skip to content

Add license and citation metadata for Zenodo and ORCID - #29

Merged
lpenap merged 2 commits into
masterfrom
lpenap/citation-metadata
Sep 21, 2026
Merged

lpenap merged 2 commits into
masterfrom
lpenap/citation-metadata

Conversation

@lpenap

@lpenap lpenap commented Sep 16, 2026 •

Copy link
Copy Markdown
Owner

Summary

Groundwork for archiving releases on Zenodo and listing the project in ORCID.

  • LICENSE: GNU GPL v3, same as java-monitor-example. Zenodo requires a license to publish an open-access record.
  • CITATION.cff: title, abstract, author (Luis Augusto Peña Pereira, ORCID 0009-0001-0739-7149), repository, license, version 8, release date, keywords, and references to Gamma et al. and the companion project. GitHub renders it as "Cite this repository"; Zenodo reads it when archiving, and the ORCID iD lets DataCite link the record to the author's profile.
  • README: license badge, a How to cite section with a commented-out Zenodo DOI badge to fill in after the first archive, and a License section. Table of contents updated.
  • pom.xml: <url> and <licenses> declared.

After merging

  1. Check that GitHub shows the "Cite this repository" button without a validation warning.
  2. On zenodo.org, enable the repository under the GitHub tab.
  3. Publish a new release (e.g. v8.1). Zenodo archives it and mints a version DOI plus a concept DOI.
  4. Replace the placeholders in the README's How to cite section with the concept DOI.
  5. In ORCID, authorise DataCite auto-update at commons.datacite.org, or add the DOI manually through Works → Search & link → DataCite.

Verification

  • ./mvnw validate passes with the pom changes
  • CITATION.cff parses as YAML; the ORCID iD resolves at pub.orcid.org and the name on record matches
  • GitHub's own validator will flag any schema issue on the repository page

🤖 Generated with Claude Code

lpenap and others added 2 commits September 16, 2026 17:07
Add the GNU GPL v3 license text, matching java-monitor-example, and a
CITATION.cff file with the project metadata so GitHub offers "Cite this
repository" and Zenodo can read title, author, license and keywords when
archiving a release. The README gains a license badge, a How to cite
section with a placeholder for the Zenodo concept DOI badge, and a
License section. The pom declares the license and project URL.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@lpenap
lpenap merged commit 2ed2dfa into master Sep 21, 2026
3 checks passed
@lpenap
lpenap deleted the lpenap/citation-metadata branch September 22, 2026 16:38
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.

1 participant