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: spec/config/1.0.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ redirect_from:
14
14
The CODECHECK process describes a workflow for a reproduction of computations as part of a scientific peer review.
15
15
CODECHECK follows a set of [principles](/) that allow many different variations into [concrete implementations](/process).
16
16
The requirements for a successful CODECHECK are intentionally kept to a minimum, as are the requirements on how codechecking is conducted, or how the procedure is documented.
17
-
At the end of the CODECHECK stands a CODECHECK report document, written by the codechecker and understandable to a person with some expertise in the scientific field of the related article.
17
+
At the end of the CODECHECK stands a CODECHECK certificate, a document written by the codechecker and understandable to a person with some expertise in the scientific field of the related article.
18
18
Besides the human-readable information in the CODECHEK report, there is a small set of metadata elements that are part of a CODECHECK procedure which are worth capturing in a more structured format.
19
19
20
20
This metadata is saved in the CODECHECK configuration file, which is specified in this document in version {{ page.version }}.
@@ -189,11 +189,11 @@ The configuration file MUST include minimal metadata about the codechecker in a
189
189
Each item in the `codechecker` sequence MUST have one node `name` with the codechecker's name.
190
190
Each item in the `codechecker` sequence SHOULD have a child `ORCID` as defined in [Author and submission metadata](#author-and-submission-metadata).
191
191
192
-
The configuration file MUST have a root-level node `report` with a unique identifier for the published CODECHECK report, such as a URL or DOI, ideally in a resolvable format.
192
+
The configuration file MUST have a root-level node `report` with a unique identifier for the published CODECHECK certificate, such as an URL or DOI, ideally in a resolvable format.
193
193
194
194
The CODECHECK CAN add further fields with the following names and semantics:
195
195
196
-
- `summary`: Short textual summary of the CODECHECK report.
196
+
- `summary`: Short textual summary of the CODECHECK certificate.
197
197
- `repository`: A URL or a list of URLs to the code or data repository/ies where more files and a version history of the checked workflow are available.
198
198
- `source`: see [`source`](#source).
199
199
- `check_time`: A date or timestamp when the CODECHECK was completed. If not time is provided, it should be assumed that codechecking was completed at the publication date of the CODECHEK report.
Copy file name to clipboardExpand all lines: spec/config/1.x.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ permalink: spec/config/1.x/
15
15
The CODECHECK process describes a workflow for a reproduction of computations as part of a scientific peer review.
16
16
CODECHECK follows a set of [principles](/) that allow many different variations into [concrete implementations](/process).
17
17
The requirements for a successful CODECHECK are intentionally kept to a minimum, as are the requirements on how codechecking is conducted, or how the procedure is documented.
18
-
At the end of the CODECHECK stands a CODECHECK report document, written by the codechecker and understandable to a person with some expertise in the scientific field of the related article.
18
+
At the end of the CODECHECK stands a CODECHECK certificate document, written by the codechecker and understandable to a person with some expertise in the scientific field of the related article.
19
19
Besides the human-readable information in the CODECHEK report, there is a small set of metadata elements that are part of a CODECHECK procedure which are worth capturing in a more structured format.
20
20
21
21
This metadata is saved in the CODECHECK configuration file, which is specified in this document in version {{ page.version }}.
@@ -190,11 +190,11 @@ The configuration file MUST include minimal metadata about the codechecker in a
190
190
Each item in the `codechecker` sequence MUST have one node `name` with the codechecker's name.
191
191
Each item in the `codechecker` sequence SHOULD have a child `ORCID` as defined in [Author and submission metadata](#author-and-submission-metadata).
192
192
193
-
The configuration file MUST have a root-level node `report` with a unique identifier for the published CODECHECK report, such as a URL or DOI, ideally in a resolvable format.
193
+
The configuration file MUST have a root-level node `report` with a unique identifier for the published CODECHECK certificate, such as a URL or DOI, ideally in a resolvable format.
194
194
195
195
The CODECHECK CAN add further fields with the following names and semantics:
196
196
197
-
- `summary`: Short textual summary of the CODECHECK report.
197
+
- `summary`: Short textual summary of the CODECHECK certificate.
198
198
- `repository`: A URL or a list of URLs to the code or data repository/ies where more files and a version history of the checked workflow are available.
199
199
- `source`: see [`source`](#source).
200
200
- `check_time`: A date or timestamp when the CODECHECK was completed. If not time is provided, it should be assumed that codechecking was completed at the publication date of the CODECHEK report.
0 commit comments