Skip to content

Commit 27aa555

Browse files
committed
Update contributing guidelines
1 parent a9b450c commit 27aa555

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,23 @@ To install the formatters and linters, run:
4545
npm install
4646
```
4747

48-
The formatter is run with:
48+
The run the formatter, use:
4949

5050
```bash
5151
npm run format
5252
```
5353

54-
The linter is run with:
54+
The run the linters, use:
5555

5656
```bash
5757
npm run lint
5858
```
5959

60+
To run the individual linters, use:
61+
62+
- `npm run lint:format` to check the formatting
63+
- `npm run lint:links` to check for invalid links in markdown
64+
6065
## Create the book
6166

6267
We use `mdbook` to generate [secure-contracts.com](https://secure-contracts.com/).

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
"prettier-plugin-solidity": "^1.1.3"
1010
},
1111
"scripts": {
12-
"format": "prettier --write . && npm run format-embedded-solidity",
13-
"format-embedded-solidity": "prettier --write \"**/*.md\" --embedded-language-formatting=auto --plugin prettier-plugin-solidity --tab-width 4 --print-width 120 && prettier --write \"**/*.md\"",
14-
"lint": "npm run lint-check-format && npm run lint-check-links",
15-
"lint-check-format": "prettier --check .",
16-
"lint-check-links": "find . -name '*.md' -print0 | xargs -0 -n1 markdown-link-check"
12+
"format": "prettier --write . && npm run format:embedded",
13+
"format:embedded": "prettier --write \"**/*.md\" --embedded-language-formatting=auto --plugin prettier-plugin-solidity --tab-width 4 --print-width 120 && prettier --write \"**/*.md\"",
14+
"lint": "npm run lint:format && npm run lint:links",
15+
"lint:format": "prettier --check .",
16+
"lint:links": "find . -name '*.md' -print0 | xargs -0 -n1 markdown-link-check"
1717
}
1818
}

0 commit comments

Comments
 (0)