tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ci: document checks and fixes

Browse Source
This commit is contained in:
Alexander Courtis
2023-12-31 17:33:51 +11:00
parent ed0c82f8e8
commit 828bbc8bc3
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -10,7 +10,7 @@ Following are used during CI and strongly recommended during local development.
Lint: [luacheck](https://github.com/lunarmodules/luacheck/)
Style: [stylua]
Style: [StyLua](https://github.com/JohnnyMorganz/StyLua)
Language server: [luals](https://luals.github.io)
@@ -22,17 +22,17 @@ The following quality checks are mandatory and are performed during CI. They run
You can run them all via `make` or `make all`
You can setup the git hooks by running `scripts/setup-hooks.sh`
You can setup git hooks to run all checks by running `scripts/setup-hooks.sh`
## lint
1. Runs luacheck quietly using `.luacheck` settings
1. Runs `scripts/doc-comments.sh` to validate annotated documentation
```sh
make lint
```
1. Runs luacheck quietly using `.luacheck` settings
1. Runs `scripts/doc-comments.sh` to validate annotated documentation
## style
Runs stylua using `.stylua.toml` settings: