diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..339f013 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,23 @@ +{ + "default": true, + "MD033": { + "allowed_elements": [ + "a", + "img", + "span", + "div", + "p", + "ul", + "li", + "h1", + "h4", + "em", + "strong", + "iframe", + "br", + "script" + ] + }, + "MD013": false, + "MD041": false +} diff --git a/guide/bundle.md b/guide/bundle.md index 1a6928b..1a34ba9 100644 --- a/guide/bundle.md +++ b/guide/bundle.md @@ -9,7 +9,7 @@ Unlike the [CODECHECK configuration file](/spec/config/latest), which has a more Therefore, this page acts as a guidance for codecheckers and may evolve over time. **The CODECHECK bundle includes all files that the codechecker used to conduct the CODECHECK.** -This may include a copy of the author's files, and any additional files that the codechecker created to assisst them in their codecheck. +This may include a copy of the author's files, and any additional files that the codechecker created to assisst them in their CODECHECK. ## Computing environment documentation diff --git a/guide/community-workflow.md b/guide/community-workflow.md index d0625f4..ff79eaf 100644 --- a/guide/community-workflow.md +++ b/guide/community-workflow.md @@ -83,7 +83,7 @@ When your workflow is ready to be CODECHECK, open an issue on the [CODECHECK reg After the publication of the CODECHECK certificate, add a reference to the certificate in your paper, e.g., in a section describing your workflow or in the acknowledgements: -> _A CODECHECK certificate is available confirming that [all of the, a (significant) part of the, the] computations underlying this article could be independently executed: https://doi.org/[certificate DOI]._ +> _A CODECHECK certificate is available confirming that [all of the, a (significant) part of the, the] computations underlying this article could be independently executed: ._ ------ @@ -156,9 +156,11 @@ Some further tips: - If the check was conducted for a piece of software for the first time or resulted in important lessons learned, consider adding it to the list of examples below. - If possible, add the [CODE WORKS badge](https://github.com/codecheckers/website/tree/master/badges) CODECHECK badge to the article or the original software repository, e.g., by sending a pull request. The badge should link directly to the Zenodo record _via the DOI_. The following snippet should work in Markdown: - ``` + + ```md [![CODECHECK](https://codecheck.org.uk/img/codeworks-badge.svg)](https://doi.org/) ``` + - 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. Every CODECHECK is unique, just as the associated research article. @@ -169,6 +171,12 @@ Reach out to fellow codecheckers in the [public CODECHECK discussion forum](http ## Codecheck editor tasks + + When a new issue is assigned to a codecheck editor in the register, here are a few things you need to do. - **First checks** @@ -177,12 +185,6 @@ When a new issue is assigned to a codecheck editor in the register, here are a f - Make sure the author has completed the [required author tasks](#requirements). - **CODECHECK workflow** - Edit the first comment of the issue and add the next available _Certificate identifier_ in `YYYY-NNN` format by checking existing open issues with [`id assigned`](https://github.com/codecheckers/register/labels/id%20assigned) for the next available number; add the badge `id assigned` to the issue. - -UPDATE AS DISCUSSED IN https://github.com/codecheckers/discussion/issues/21 - -update Zenodo metadata to include a link to the published paper - - - [Find a codechecker](https://github.com/codecheckers/codecheckers/) and invite them by @-mentioning in the register issue. Remove the [`needs codechecker`](https://github.com/codecheckers/register/labels/needs%20codechecker) label when you found one. Good job so far! - Use the following labels to document the current state of the check: [`work in progress`](https://github.com/codecheckers/register/labels/work%20in%20progress), [`metadata pending`](https://github.com/codecheckers/register/labels/metadata%20pending) - Support the codechecker as needed (sent reminders, technical support, mediate between author and codechecker, et cetera); _all communication should happen within the GitHub issue on the register!_ @@ -227,7 +229,7 @@ Codechecker: [@sje30](https://github.com/sje30) and [@nuest](https://github.com/ Report: [http://doi.org/10.5281/zenodo.3750741](http://doi.org/10.5281/zenodo.3750741) -### GIScience/Geography/Geoinformatics 🌏🌎🌍 +### GIScience/Geography/Geoinformatics 🌏🌎🌍 #### [Brunsden & Comber, 2020](https://github.com/codecheckers/OpeningPractice) @@ -247,4 +249,4 @@ Report: [https://doi.org/10.5281/zenodo.4279275](https://doi.org/10.5281/zenodo. ### _Your scientific dispipline here..._ -**[Get involved!](/get-involved)** \ No newline at end of file +**[Get involved!](/get-involved)** diff --git a/index.md b/index.md index 2937424..6c4bd16 100644 --- a/index.md +++ b/index.md @@ -99,7 +99,7 @@ Thanks, Markus, for spreading the word about CODECHECK and for introducing more ### 2022-06 | AGILE Reproducibility Review 2022 The collaboration between CODECHECK and the AGILE conference series continues! -In 2022, the AGILE conference's [reproducibility committee]() conducted 16 reproductions of conference full papers. +In 2022, the AGILE conference's [reproducibility committee](https://reproducible-agile.github.io/2022/#reproducibility-committee) conducted 16 reproductions of conference full papers. Take a look at the slides presented at the final conference day [here](https://doi.org/10.5281/zenodo.6625206). The reproducibility review took place after the scientific review. The reproducibility reports, the AGILE conference's are published on OSF at and listed in the [CODECHECK register](https://codecheck.org.uk/register/). @@ -161,7 +161,7 @@ Stephen Eglen presented CODECHECK at [The 14th Munin Conference on Scholarly Pub > Take a look at the [poster](https://septentrio.uit.no/index.php/SCS/article/view/4910/4893) and the [slides](https://septentrio.uit.no/index.php/SCS/article/view/4910/4900), or watch the [video recording](https://mediasite.uit.no/Mediasite/Play/8027873496dc465ebc4b9b3ab0338ad01d?playFrom=1772000). > -> [![](/img/munin-2019.jpg)](https://mediasite.uit.no/Mediasite/Play/8027873496dc465ebc4b9b3ab0338ad01d?playFrom=1772000) +> [![screenshot of livestream of the talk by Stephen Eglen at MUNIN 2019](/img/munin-2019.jpg)](https://mediasite.uit.no/Mediasite/Play/8027873496dc465ebc4b9b3ab0338ad01d?playFrom=1772000) ------ @@ -188,7 +188,7 @@ To get or give a quick overview of the project, feel free to use or extend the [ $(document).ready(function(){ var checks = []; var stats = {}; - + $.when( $.ajax({ type: "get",