Skip to content

Commit 6dbe611

Browse files
authored
add badge info to authors' get involed
1 parent 74e468e commit 6dbe611

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

get-involved.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ You want to share the code underlying your research paper? **Congratulations** f
1818
There are different ways for you to get involved, for example (a) submit a manuscript to a journal conducting CODECHECKs, (b) suggest a CODECHECK as part of your cover letter, or (c) submit your workflow to the [community review process](/guide/community-workflow) right away if you have published a preprint or submit to a journal with an open review.
1919
If you want to reference the CODECHECK project in your manuscript, please use the citation provided at the end of this page.
2020

21+
Your work was codechecked? Good job!
22+
Please consider adding 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 your repository or your personal website when you list your works.
23+
The badge should link directly to the Zenodo record using the DOI.
24+
The following snippet should work in Markdown:
25+
26+
```md
27+
[![CODECHECK](https://codecheck.org.uk/img/codeworks-badge.svg)](https://doi.org/<DOI HERE>)
28+
```
29+
2130
## As a reviewer or editor
2231

2332
If you are contributing to science as a reviewer of academic manuscripts or as a journal editor, you can initiate a CODECHECK for submitted articles if the author provides suitable information.
@@ -29,12 +38,13 @@ You are an editor or reviewer at a journal or conference and are interested to i
2938

3039
**Great!**
3140
There is no formal process or certification.
32-
You can simply announce publicly that you conduct a code review adhereing to the CODECHECK principles, e.g. in a blog post.
41+
However, we are very interested in helping you to get started.
42+
You can simply announce publicly that you conduct a workflow review adhereing to the CODECHECK principles, e.g., in a blog post.
3343
A link to the CODECHECK principles in your submission guidelines would probably be helpful for authors and reviewers.
3444
Please consider adding a <img src="/img/codeworks-badge.svg" alt="CODECHECK badge" height="16" style="margin-top: -4px;" /> badge to the publication to highlight the fact that a CODECHECK was conducted.
3545
The badge should link directly to the CODECHECK certificate.
3646

37-
The badge graphic and all documentation on this website are available under open licenses, see [this README](https://github.com/codecheckers/website/blob/master/README.md).
47+
The badge graphic, the CODECHECK logo, and all documentation on this website are available under open licenses, see [this README](https://github.com/codecheckers/website/blob/master/README.md).
3848

3949
The [CODECHECK team](/partners) would be glad to help you set up a process, if you have any questions - see contacts information below.
4050
We would be happy to list your journal of conference on our website after we have gotten to know your implementation of a CODECHECK process and you have completed your first CODECHECK.

0 commit comments

Comments
 (0)