Skip to content

Commit

Permalink
feat(CONTRIBUTING.md): Add info regarding ESLint
Browse files Browse the repository at this point in the history
  • Loading branch information
@huber-th @caksoylar
huber-th authored and caksoylar committed Mar 5, 2024
1 parent 37af94e commit 08ab45f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 08ab45f

Please sign in to comment.