Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CodeMeta JSON-LD Context File #891

Closed
4 tasks done
matthewfeickert opened this issue Jun 3, 2020 · 3 comments · Fixed by #1091
Closed
4 tasks done

Add CodeMeta JSON-LD Context File #891

matthewfeickert opened this issue Jun 3, 2020 · 3 comments · Fixed by #1091
Assignees
Labels
docs Documentation related

Comments

@matthewfeickert
Copy link
Member

matthewfeickert commented Jun 3, 2020

Description

As part of an IRIS-HEP initiative to improve the citation quality/ease for all software it has been recommended by @danielskatz that projects:

  • Track authors/contributors to software as it is developed
  • Create a citation metadata file in the software repo and keep it up to date
  • Link Github and Zenodo to get DOIs for major releases
  • In the README and docs clearly says how to cite the software

pyhf already does all of this, as:

  • There is an AUTHORS file as well as a listing of the authors in the docs
  • There is a .zenodo.json that formats Zenodo with the correct metadata and adds the ORCID of the authors
  • There is a Zenodo DOI that is kept in sync with our release schedule (almost) fully automatically (almost as it requires 1 button click). DOI
  • There is a Citation section in both the README and the docs webpage with the preferred citation

It has been pointed out though that we should also look into adding a CodeMeta Project JSON-LD Context File as with it

zenodo will read [it] and will be basically the same as schema.org so that this will help google index software, and tools be able to use the metadata file in softwareheritage.org to automatically build a citation for a particular commit.

(cc @gordonwatts as this might be of interest)

@matthewfeickert matthewfeickert added the docs Documentation related label Jun 3, 2020
@matthewfeickert matthewfeickert self-assigned this Jun 3, 2020
@matthewfeickert
Copy link
Member Author

As an example, the parsl library has a codemeta.json file.

@danielskatz
Copy link

tools to generate CodeMeta files are in https://codemeta.github.io/tools/

@matthewfeickert
Copy link
Member Author

While it doesn't look to be very actively developed, it should be possible to add a GHA workflow to use codemetapy to automatically update the codemeta.json on release merges in the same way that we run bumpversion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants