From 828bbc8bc374b8948befb8f8804372107d71f77e Mon Sep 17 00:00:00 2001 From: Alexander Courtis Date: Sun, 31 Dec 2023 17:33:51 +1100 Subject: [PATCH] ci: document checks and fixes --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e2f2d5d..206ede18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: