Skip to content

Commit 1d00db5

Browse files
committed
consistently use "certificate" instead of report
1 parent e57c37a commit 1d00db5

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The _files_ and _archives_ (a Docker image is a tarball of a directory system) w
6868

6969
## What's the correct way of writing CODECHECK?
7070

71-
- CODECHECK process.
71+
- A CODECHECK process implementation, the so called CODECHECK workflow, describes what happens before and after a paper has been codechecked.
7272
- A codechecker codechecks an article and creates the CODECHECK bundle.
73-
- Codecheckers write CODECHECK reports.
74-
- The CODECHECK report is created by the codechecker during the codechecking process.
73+
- Codecheckers write CODECHECK certificate.
74+
- The CODECHECK certificate is created by the codechecker during the codechecking process.

spec/config/1.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ redirect_from:
1414
The CODECHECK process describes a workflow for a reproduction of computations as part of a scientific peer review.
1515
CODECHECK follows a set of [principles](/) that allow many different variations into [concrete implementations](/process).
1616
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.
1818
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.
1919

2020
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
189189
Each item in the `codechecker` sequence MUST have one node `name` with the codechecker's name.
190190
Each item in the `codechecker` sequence SHOULD have a child `ORCID` as defined in [Author and submission metadata](#author-and-submission-metadata).
191191

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.
193193

194194
The CODECHECK CAN add further fields with the following names and semantics:
195195

196-
- `summary`: Short textual summary of the CODECHECK report.
196+
- `summary`: Short textual summary of the CODECHECK certificate.
197197
- `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.
198198
- `source`: see [`source`](#source).
199199
- `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.

spec/config/1.x.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ permalink: spec/config/1.x/
1515
The CODECHECK process describes a workflow for a reproduction of computations as part of a scientific peer review.
1616
CODECHECK follows a set of [principles](/) that allow many different variations into [concrete implementations](/process).
1717
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.
1919
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.
2020

2121
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
190190
Each item in the `codechecker` sequence MUST have one node `name` with the codechecker's name.
191191
Each item in the `codechecker` sequence SHOULD have a child `ORCID` as defined in [Author and submission metadata](#author-and-submission-metadata).
192192

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.
194194

195195
The CODECHECK CAN add further fields with the following names and semantics:
196196

197-
- `summary`: Short textual summary of the CODECHECK report.
197+
- `summary`: Short textual summary of the CODECHECK certificate.
198198
- `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.
199199
- `source`: see [`source`](#source).
200200
- `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

Comments
 (0)