You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+24-5Lines changed: 24 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,30 @@ Don't forget to add your new article to the `SUMMARY.md` to let it be rendered t
40
40
41
41
Please make `Draft Pull requests` early so we can follow your progress and can give early feedback (see the following section).
42
42
43
+
## Check the article locally
44
+
45
+
Before submitting the PR launch the commands `mdbook build` to make sure that the book builds and `mdbook test` to make sure that
46
+
code examples are correct.
47
+
48
+
### Markdown lint
49
+
50
+
To make sure the files comply with our Markdown style we use [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli).
51
+
To spare you some manual work to get through the CI test you can use the following commands to automatically fix most of the emerging problems when writing Markdown files.
52
+
53
+
- Install:
54
+
55
+
```sh
56
+
npm install -g markdownlint-cli
57
+
```
58
+
59
+
- Check all markdown files:
60
+
- unix: `markdownlint '**/*.md'`
61
+
- windows: `markdownlint **/*.md`
62
+
63
+
- Automatically fix basic errors:
64
+
- unix: `markdownlint -f '**/*.md'`
65
+
- windows: `markdownlint -f **/*.md`
66
+
43
67
## Creating a Pull Request
44
68
45
69
"Release early and often!" also applies to pull requests!
@@ -49,11 +73,6 @@ Early reviews of the community are not meant as an offense but to give feedback.
49
73
50
74
A good principle: "Work together, share ideas, teach others."
51
75
52
-
### Test the book locally before submitting
53
-
54
-
Before submitting the PR launch the commands `mdbook build` to make sure that the book builds and `mdbook test` to make sure that
55
-
code examples are correct.
56
-
57
76
### Important Note
58
77
59
78
Please **don't force push** commits in your branch, in order to keep commit history and make it easier for us to see changes between reviews.
0 commit comments