Skip to content

Commit eeaef52

Browse files
committed
docs(prettier): add coding rules section in contributing.md
1 parent c371db5 commit eeaef52

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Please follow these guidelines when reporting issues:
2020
You consider contributing changes to node-wifi – we dig that!
2121
Please consider these guidelines when filing a pull request:
2222

23+
- Follow the [Coding Rules](#coding-rules)
2324
- Follow the [Commit Rules](#commit-rules)
2425
- Make sure you rebased the current master branch when filing the pull request
2526
- Squash your commits when filing the pull request
@@ -35,6 +36,17 @@ Please consider these guidelines when filing a pull request:
3536

3637
**May the force be with you !!**
3738

39+
## Coding Rules
40+
41+
To keep the code base of commitlint neat and tidy the following rules apply to every change
42+
43+
- `prettier` is king
44+
- `eslint` is awesome
45+
- Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
46+
- Be awesome
47+
48+
> use commands `npm run eslint` and `npm run prettier:check` to be sure your code respect coding rules.
49+
3850
## Commit Rules
3951

4052
To help everyone with understanding the commit history of commitlint the following commit rules are enforced.

0 commit comments

Comments
 (0)