Skip to content

Commit

Permalink
feat: .zenodo.json added fix #8
Browse files Browse the repository at this point in the history
  • Loading branch information
maehr committed Apr 25, 2024
1 parent 5c8abf5 commit 3b0ae01
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .zenodo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"title": "My Research Software",
"version": "0.11.2",
"publication_date": "2021-10-13",
"keywords": ["amazing software", "research"],
"license": {
"id": "AGPL-3.0"
},
"upload_type": "software",
"description": "This is my awesome research software. It does many things.",
"creators": [
{
"name": "Doe, John",
"orcid": "https://orcid.org/0000-0001-8888-9999"
}
],
"access_right": "open",
"related_identifiers": [
{
"identifier": "10.5281/zenodo.123456",
"relation": "isVersionOf",
"resource_type": "software"
},
{
"identifier": "10.5281/zenodo.123457",
"relation": "isIdenticalTo",
"resource_type": "software"
}
],
"communities": [
{
"identifier": "your-community-here"
}
],
"notes": "If you use this software, please cite it using the metadata from this file.",
"repository": "https://github.com/USERNAME/REPO_NAME/"
}
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ npm run prepare
- [ ] [protect](https://help.github.com/en/articles/configuring-protected-branches) the main branch to enforce a [fork and pull](https://gist.github.com/Chaser324/ce0505fbed06b947d962) workflow
- [ ] search and replace `FULLNAME`, `USERNAME`, `REPO_NAME`, `SHORT_DESCRIPTION` `[INSERT CONTACT METHOD]` in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), [package.json](package.json), [README.template.md](README.template.md), [SECURITY.md](SECURITY.md)
- [ ] change `CITATION.CFF` according to [citation-file-format.github.io](https://citation-file-format.github.io/)
- [ ] change `.zenodo.json` according to [zenodo.org](https://developers.zenodo.org/?python#add-metadata-to-your-github-repository-release)
- [ ] setup the [Zenodo integration](https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content)
- [ ] add `ZENODO_RECORD` to [README.md](README.md)
- [ ] add favicons to `./`, e.g. via [favicon.io](https://favicon.io/)
Expand Down

0 comments on commit 3b0ae01

Please sign in to comment.