Skip to content

Add AUTHORS.md, CITATION.cff and codemeta.json - #78

Merged
lfoppiano merged 1 commit into
masterfrom
add-citation-metadata
Nov 18, 2026
Merged

lfoppiano merged 1 commit into
masterfrom
add-citation-metadata

Conversation

@lfoppiano

Copy link
Copy Markdown
Collaborator

Create a HAL software record linked to GitHub and Software Heritage: the repository had no authors file and no CodeMeta metadata.

  • AUTHORS.md: authors (Lopez, Foppiano, Du, Howison) with ORCIDs, contributors, and Sloan Foundation / Softcite dataset acknowledgements
  • CITATION.cff: hand-maintained source of truth, preferred citation is the CIKM '21 paper
  • codemeta.json: generated from CITATION.cff with cffconvert 2.0.0, never edited by hand (same setup as grobid, #1631)
  • "Citation metadata" workflow (copied from grobid): validates CITATION.cff, fails when codemeta.json is out of sync, and on release tags checks that the CFF version matches the release
  • README: point to the metadata files and how to regenerate codemeta.json

Requested by Inria (IES) to create a HAL software record linked to
GitHub and Software Heritage: the repository had no authors file and no
CodeMeta metadata.

- AUTHORS.md: authors (Lopez, Foppiano, Du, Howison) with ORCIDs,
  contributors, and Sloan Foundation / Softcite dataset acknowledgements
- CITATION.cff: hand-maintained source of truth, preferred citation is
  the CIKM '21 paper
- codemeta.json: generated from CITATION.cff with cffconvert 2.0.0,
  never edited by hand (same setup as grobid, #1631)
- "Citation metadata" workflow (copied from grobid): validates
  CITATION.cff, fails when codemeta.json is out of sync, and on release
  tags checks that the CFF version matches the release
- README: point to the metadata files and how to regenerate codemeta.json
@lfoppiano
lfoppiano merged commit 782d0e9 into master Nov 18, 2026
1 check passed
@lfoppiano
lfoppiano deleted the add-citation-metadata branch November 18, 2026 01:20
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