Skip to content

Commit 6eecf86

Browse files
committed
add Markdownlint configuration and adjust some files
1 parent 5ca50e5 commit 6eecf86

File tree

4 files changed

+39
-14
lines changed

4 files changed

+39
-14
lines changed

.markdownlint.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"default": true,
3+
"MD033": {
4+
"allowed_elements": [
5+
"a",
6+
"img",
7+
"span",
8+
"div",
9+
"p",
10+
"ul",
11+
"li",
12+
"h1",
13+
"h4",
14+
"em",
15+
"strong",
16+
"iframe",
17+
"br",
18+
"script"
19+
]
20+
},
21+
"MD013": false,
22+
"MD041": false
23+
}

guide/bundle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Unlike the [CODECHECK configuration file](/spec/config/latest), which has a more
99
Therefore, this page acts as a guidance for codecheckers and may evolve over time.
1010

1111
**The CODECHECK bundle includes all files that the codechecker used to conduct the CODECHECK.**
12-
This may include a copy of the author's files, and any additional files that the codechecker created to assisst them in their codecheck.
12+
This may include a copy of the author's files, and any additional files that the codechecker created to assisst them in their CODECHECK.
1313

1414
## Computing environment documentation
1515

guide/community-workflow.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ When your workflow is ready to be CODECHECK, open an issue on the [CODECHECK reg
8383

8484
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:
8585

86-
> _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]._
86+
> _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>._
8787
8888
------
8989

@@ -156,9 +156,11 @@ Some further tips:
156156
- 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.
157157
- If possible, add the [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 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_.
158158
The following snippet should work in Markdown:
159-
```
159+
160+
```md
160161
[![CODECHECK](https://codecheck.org.uk/img/codeworks-badge.svg)](https://doi.org/<DOI HERE>)
161162
```
163+
162164
- 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.
163165

164166
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
169171

170172
## Codecheck editor tasks
171173

174+
<!--
175+
TODO: UPDATE AS DISCUSSED IN <https://github.com/codecheckers/discussion/issues/21>
176+
177+
update Zenodo metadata to include a link to the published paper
178+
-->
179+
172180
When a new issue is assigned to a codecheck editor in the register, here are a few things you need to do.
173181

174182
- **First checks**
@@ -177,12 +185,6 @@ When a new issue is assigned to a codecheck editor in the register, here are a f
177185
- Make sure the author has completed the [required author tasks](#requirements).
178186
- **CODECHECK workflow**
179187
- 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.
180-
181-
UPDATE AS DISCUSSED IN https://github.com/codecheckers/discussion/issues/21
182-
183-
update Zenodo metadata to include a link to the published paper
184-
185-
186188
- [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!
187189
- 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)
188190
- 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/
227229

228230
Report: [http://doi.org/10.5281/zenodo.3750741](http://doi.org/10.5281/zenodo.3750741)
229231

230-
### GIScience/Geography/Geoinformatics 🌏🌎🌍
232+
### GIScience/Geography/Geoinformatics 🌏🌎🌍
231233

232234
#### [Brunsden & Comber, 2020](https://github.com/codecheckers/OpeningPractice)
233235

@@ -247,4 +249,4 @@ Report: [https://doi.org/10.5281/zenodo.4279275](https://doi.org/10.5281/zenodo.
247249

248250
### _Your scientific dispipline here..._
249251

250-
**[Get involved!](/get-involved)**
252+
**[Get involved!](/get-involved)**

index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Thanks, Markus, for spreading the word about CODECHECK and for introducing more
9999
### 2022-06 | AGILE Reproducibility Review 2022
100100

101101
The collaboration between CODECHECK and the AGILE conference series continues!
102-
In 2022, the AGILE conference's [reproducibility committee]() conducted 16 reproductions of conference full papers.
102+
In 2022, the AGILE conference's [reproducibility committee](https://reproducible-agile.github.io/2022/#reproducibility-committee) conducted 16 reproductions of conference full papers.
103103
Take a look at the slides presented at the final conference day [here](https://doi.org/10.5281/zenodo.6625206).
104104
The reproducibility review took place after the scientific review.
105105
The reproducibility reports, the AGILE conference's are published on OSF at <https://osf.io/r5w79/> 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
161161

162162
> 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).
163163
>
164-
> [![](/img/munin-2019.jpg)](https://mediasite.uit.no/Mediasite/Play/8027873496dc465ebc4b9b3ab0338ad01d?playFrom=1772000)
164+
> [![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)
165165
166166
------
167167

@@ -188,7 +188,7 @@ To get or give a quick overview of the project, feel free to use or extend the [
188188
$(document).ready(function(){
189189
var checks = [];
190190
var stats = {};
191-
191+
192192
$.when(
193193
$.ajax({
194194
type: "get",

0 commit comments

Comments
 (0)