Skip to content

Commit caaea63

Browse files
committed
update NL workflow
1 parent 1200a77 commit caaea63

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

nl/workflow.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ The following steps are required to complete a CODECHECK as part of a workshop o
77
See also the [CODECHECK community workflow overview](/guide/community-workflow-overview) for a broader approach.
88
Before you start, note that every CODECHECK is unique, just as the associated research article.
99
Reach out to fellow codecheckers in the [public CODECHECK discussion forum](https://github.com/codecheckers/discussion/issues) if you face any problems, or use the [internal team discussion](https://github.com/orgs/codecheckers/teams/codecheckers) if you need to consult in private.
10+
You are probably doing fine even if you digress from this documentation.
1011

11-
You are probably doing fine even if you digress vom this documentation.
12+
## Steps
1213

13-
## Codechecker tasks - in-person workshop
14-
15-
1. Authors create a pre-producible workflow: all data and code, plus a readme file detailing the content, a manifest file detailing the [output CODECHECK configuration file](/spec/config/1.0/), and a license file; this is ideally bundled in a single repository or archive file and accompanied by a (pre-published) paper
16-
1. Authors send their request for a CODECHECK to project e-mail address [[email protected]](mailto:[email protected])
14+
1. **Authors** create a pre-producible workflow: all data and code, plus a readme file detailing the content, a manifest file detailing the [output CODECHECK configuration file](/spec/config/1.0/), and a license file; this is ideally bundled in a single repository or archive file and accompanied by a (pre-published) paper
15+
1. **Authors** send their request for a CODECHECK to project e-mail address [[email protected]](mailto:[email protected])
1716
1. The CodecheckNL project team accepts the request for the workshop or advises to follow the normal community workflow (see above)
1817
1. During the workshop, codecheckers download materials or clone the a repository
1918
1. The workshop codecheckers create a new directory in their working environment where all new files go, and start documenting the ongoing codecheck; exact form of codechecking procedure and form of documentation vary greatly, but there are some tools, such as an R package to automate some steps, including a Rmd template; all of that is optional, as long as the final report contains the mandatory information

0 commit comments

Comments
 (0)