diff options
| author | kylo252 <[email protected]> | 2021-08-13 12:11:18 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-08-13 12:11:18 +0200 |
| commit | 988c74ec5665250c572dcc6bae018ed0ea180c25 (patch) | |
| tree | 747556740d360482fc0edfc7ce5ce996bbbca06a /CONTRIBUTING.md | |
| parent | 6bbce4ee07ac8428846dfb6722e15a932d6d9e05 (diff) | |
feat: Add pre-commit hook for linting and formatting (#1132)
* feat: Add pre-commit hook for linting and formatting
* format with prettier
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7606fe46..45edf8c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +17,19 @@ One of the best ways to begin contributing in a meaningful way is by helping fin ## Setting up development tools -1. Install [stylua](https://github.com/johnnymorganz/stylua#installation) +### For editing Lua files -2. Install [shfmt](https://github.com/mvdan/sh#shfmt) +1. Formatter: [stylua](https://github.com/johnnymorganz/stylua#installation). +2. Linter: [luacheck](https://github.com/luarocks/luacheck). + +### For editing shell scripts + +1. Formatter: [shfmt](https://github.com/mvdan/sh#shfmt). +2. Linter: [shellcheck](https://github.com/koalaman/shellcheck). + +### (Optional) + +Install [pre-commit](https://github.com/pre-commit/pre-commit) which will run all linters and formatters for you as a pre-commit-hook. ## Some Guidelines |