zoriya/zmk
1
0
Fork 0
mirror of https://github.com/zoriya/zmk.git synced 2025-12-06 06:56:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(CONTRIBUTING.md): Add info regarding ESLint

Browse Source
This commit is contained in:
Thomas Huber
2024-03-03 21:10:14 -08:00
committed by Cem Aksoylar
parent 37af94edde
commit 08ab45fc78
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -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`. 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`. 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 ## Code Contributions
### Development Setup ### Development Setup