Skip to content

Commit 1593c0d

Browse files
committed
better connect with curation policy on Zenodo
1 parent aa27964 commit 1593c0d

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

guide/community-workflow-codechecker.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Some further tips:
8080
- Is the data and [software](https://content.iospress.com/articles/data-science/ds190026) FAIR?
8181
1. Add **mandatory codechecker-contributed information** to the **`codecheck.yml`** file, see [spec](/spec/config/latest)
8282
1. Wait for the article DOI.
83-
1. **Deposit the CODECHECK report on _Zenodo_** using your own Zenodo account.
83+
1. **Deposit the CODECHECK report on _Zenodo_** using your own Zenodo account and following the [community curation policy](https://zenodo.org/communities/codecheck/curation-policy) (which is replicated here for convenience):
8484
- _Reserve a DOI_
8585
- Add the DOI to the `codecheck.yml` file.
8686
- Add the DOI to the `codecheck.pdf` CODECHECK report, which should include a full citation of itself.
@@ -89,16 +89,21 @@ Some further tips:
8989
- Optional: You can add any material to this record that you see fit, especially things that helped you with your reproduction, i.e., the [CODECHECK bundle](/guide/bundle).
9090
- _Communities_: Search for "codecheck" to add the record to the [CODECHECK community on Zenodo](https://zenodo.org/communities/codecheck).
9191
- _Authors_: Add all codecheckers as authors.
92-
- _Title_: `"CODECHECK Certificate YYYY-NNN"` (certificate number issued via the register ticket above).
92+
- _Title_: `"CODECHECK Certificate YYYY-NNN"` (certificate number issued via the register ticket above, optionally you may add the submission's title).
9393
- _License_: Use `Creative Commons Attribution 4.0 International` if you only upload the CODECHECK report, otherwise use `Other (Open)` or `Other (Attribution)` and document the licensing of the different parts in an _Additional notes_ field.
9494
- _Description_: Copy the summary of the check here.
9595
- _Contributors_: Add the original authors as contributors (see Zendo Metadata form section "Contributors (optional)") with a suitable role (e.g., "Researcher").
96+
- Add a _Relationship_ in metadata between the certificate and the original paper/submission.
97+
- Relation: `Reviews` (= the certificate reviews the article)
98+
- Identifier & Scheme: `the identifier` (ideally the article's DOI)
99+
- Resource type: `Publication` (with clarification as fitting, e.g., `Publication / Journal article`)
100+
- Add the certificate identifier as an _Alternative identifier_, e.g., <https://zenodo.org/records/14576035>
101+
- With schema URL using `http://cdchck.science/register/certs/<CERT ID>`
102+
- With schema Other using `cdchck.science/register/certs/<CERT ID>`
96103
- _Optionally_, add extra metadata as you see fit (fields such as _Version_, _Language_, _Keywords_).
97104
- Connect the Zenodo record to the GitHub repository with a _Relate/alternate identifier_.
98105
- Connect the Zenodo record to the article/preprint with a _Related/alternate identifier_.
99-
1. If the check was conducted for a piece of software for the first time or resulted in important lessons learned, please suggest it to the editor in the checks's GitHub issue.
100-
1. If the check material is published on `github.com/codecheckers`, add the [`codecheck` topic](https://github.com/search?q=topic%3Acodecheck+fork%3Atrue+org%3Acodecheckers&type=Repositories) to the project.
101-
1. If possible, add the [CODE WORKS badge](https://github.com/codecheckers/website/tree/master/badges) <img src="/img/codeworks-badge.svg" alt="CODECHECK badge" height="16" style="margin-top: -4px;" /> to the software repository, e.g., by sending a pull request.
106+
1. If possible, coordinate with the original author(s) to add a [CODE WORKS badge](https://github.com/codecheckers/website/tree/master/badges) <img src="/img/codeworks-badge.svg" alt="CODECHECK badge" height="16" style="margin-top: -4px;" /> to their repository, e.g., by sending a pull request on GitHub, a merge request on GitLab, or sending them an HTML snippet for their personal website.
102107
The badge should link directly to the Zenodo record _via the DOI_.
103108
The following snippet should work in Markdown:
104109

guide/community-workflow-editor.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ When a new issue is assigned to a codecheck editor in the register, here are a f
2323
- Ensure that a reference to the certificate is/will be added to the manuscript.
2424
1. **Certificate publication and register**
2525
- Wait until the article is published in a citable form.
26-
- Ask the codechecker to update all required metadata in the `codecheck.yml` and update the certificate report (especially the final DOIs!); double-check the information in the metadata and the actual certificate; wait until the certificate is published with its own DOI.
27-
- Alternatively, you may make edits to the metadata in the forked repository yourself, request write access to the OSF repository to edit the metadata, or handle edits via Zenodo yourself (metadata editing in CODECHECK community, or even at the stage of a shared draft of a Zenodo record).
26+
- Ask the codechecker to update all required metadata in the `codecheck.yml` and to update the certificate report (especially the final DOIs!)
27+
- Revisit the [CODECHECK community curation policy](https://zenodo.org/communities/codecheck/curation-policy) to make sure you follow the most updated guideline
28+
- Double-check the information in the metadata and the actual certificate; wait until the certificate is published with its own DOI.
29+
- Alternatively, you may make edits to the metadata in the forked repository yourself, request write access to the OSF repository to edit the metadata, or handle edits via Zenodo yourself (metadata editing in CODECHECK community, or even at the stage of a shared draft of a Zenodo record).
2830
- Trigger a rebuild of the register by adding the CODECHECK to the `register.csv` file; you may add a `closes #N` statement in the commit message to close the isue.
2931
- Clear up the labels of the register issue - all labels except the [`community`](https://github.com/codecheckers/register/labels/community)/[`journal`](https://github.com/codecheckers/register/labels/journal)/[`conference/workshop`](https://github.com/codecheckers/register/labels/conference%2Fworkshop) should be removed.
3032
- "Archive" the repository clone in the codecheckers organisation on GitHub/the cdchk organisation on GitLab ([instructions for GitHub](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-archiving-repositories), [instructions for GitLab](https://docs.gitlab.com/ee/user/project/working_with_projects.html#archive-a-project))

0 commit comments

Comments
 (0)