diff options
| author | Thomas Huber <[email protected]> | 2024-03-03 21:10:14 -0800 |
|---|---|---|
| committer | Cem Aksoylar <[email protected]> | 2024-03-04 20:08:52 -0800 |
| commit | 08ab45fc7875a042c787d353ff0e3512319af030 (patch) | |
| tree | a9884f4a7f09a559bc4113c04de3c61a7ad5a82b /CONTRIBUTING.md | |
| parent | 37af94edde7b42f1894484831b6d958bc4b27124 (diff) | |
| download | zmk-08ab45fc7875a042c787d353ff0e3512319af030.tar.gz zmk-08ab45fc7875a042c787d353ff0e3512319af030.zip | |
feat(CONTRIBUTING.md): Add info regarding ESLint
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe7292a8fe..bcc2aef190 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,6 +86,12 @@ documentation to areas not currently covered are greatly appreciated. ZMK uses `prettier` to format documentation files. You can run prettier with `npm run prettier:format`. You can setup git to run prettier automatically when you commit by installing the pre-commit hooks: `pip3 install pre-commit`, `pre-commit install`. +### Linting + +This repository utilizes ESLint for code linting to ensure consistent code style and identify potential errors or bugs early in the development process. + +You can run ESLint with `npm run lint` to verify your changes. + ## Code Contributions ### Development Setup |