You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guide/community-workflow-codechecker.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,7 @@ Some further tips:
80
80
- Is the data and [software](https://content.iospress.com/articles/data-science/ds190026) FAIR?
81
81
1. Add **mandatory codechecker-contributed information** to the **`codecheck.yml`** file, see [spec](/spec/config/latest)
82
82
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):
84
84
-_Reserve a DOI_
85
85
- Add the DOI to the `codecheck.yml` file.
86
86
- Add the DOI to the `codecheck.pdf` CODECHECK report, which should include a full citation of itself.
@@ -89,16 +89,21 @@ Some further tips:
89
89
- 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).
90
90
-_Communities_: Search for "codecheck" to add the record to the [CODECHECK community on Zenodo](https://zenodo.org/communities/codecheck).
91
91
-_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).
93
93
-_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.
94
94
-_Description_: Copy the summary of the check here.
95
95
-_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)
- 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>`
96
103
-_Optionally_, add extra metadata as you see fit (fields such as _Version_, _Language_, _Keywords_).
97
104
- Connect the Zenodo record to the GitHub repository with a _Relate/alternate identifier_.
98
105
- 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) <imgsrc="/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) <imgsrc="/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.
102
107
The badge should link directly to the Zenodo record _via the DOI_.
Copy file name to clipboardExpand all lines: guide/community-workflow-editor.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,8 +23,10 @@ When a new issue is assigned to a codecheck editor in the register, here are a f
23
23
- Ensure that a reference to the certificate is/will be added to the manuscript.
24
24
1.**Certificate publication and register**
25
25
- 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).
28
30
- 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.
29
31
- 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.
30
32
- "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