Skip to content

Commit 828bbc8

Browse files
committed
ci: document checks and fixes
1 parent ed0c82f commit 828bbc8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Following are used during CI and strongly recommended during local development.
1010

1111
Lint: [luacheck](https://github.com/lunarmodules/luacheck/)
1212

13-
Style: [stylua]
13+
Style: [StyLua](https://github.com/JohnnyMorganz/StyLua)
1414

1515
Language server: [luals](https://luals.github.io)
1616

@@ -22,17 +22,17 @@ The following quality checks are mandatory and are performed during CI. They run
2222

2323
You can run them all via `make` or `make all`
2424

25-
You can setup the git hooks by running `scripts/setup-hooks.sh`
25+
You can setup git hooks to run all checks by running `scripts/setup-hooks.sh`
2626

2727
## lint
2828

29+
1. Runs luacheck quietly using `.luacheck` settings
30+
1. Runs `scripts/doc-comments.sh` to validate annotated documentation
31+
2932
```sh
3033
make lint
3134
```
3235

33-
1. Runs luacheck quietly using `.luacheck` settings
34-
1. Runs `scripts/doc-comments.sh` to validate annotated documentation
35-
3636
## style
3737

3838
Runs stylua using `.stylua.toml` settings:

0 commit comments

Comments
 (0)