Skip to content

Commit 46628eb

Browse files
committed
Update "Formatting and linting" section
1 parent 71e0608 commit 46628eb

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,24 @@ Below is a rough outline of building-secure-contracts's structure:
3737
└── ...
3838
```
3939

40-
## Linters
40+
## Linting and formatting
4141

42-
We run [markdown-link-check](https://github.com/tcort/markdown-link-check) to ensure all the markdown links are correct.
42+
To install the formatters and linters, run:
4343

44-
To install `markdown-link-check`:
44+
```bash
45+
npm install
46+
```
47+
48+
The formatter is run with:
4549

4650
```bash
47-
npm install -g markdown-link-check
51+
npm run format
4852
```
4953

50-
To run `markdown-link-check`:
54+
The linter is run with:
5155

5256
```bash
53-
find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check
57+
npm run lint
5458
```
5559

5660
## Create the book

0 commit comments

Comments
 (0)