dominik/homepage-plus
1
0
Fork 0
mirror of https://github.com/DI0IK/homepage-plus.git synced 2025-07-07 06:08:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add instructions to dev docs for pre-commit

Browse source
This commit is contained in:
shamoon 2023-10-17 23:26:59 -07:00
parent 19c25713c4
commit f48cf0dc9f
3 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/more/development.md
View file

@ -31,6 +31,15 @@ Once dependencies have been installed you can lint your code with
pnpm lint
```
## Code formatting with pre-commit hooks
To ensure a consistent style and formatting across the project source, the project utilizes Git [`pre-commit`](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) hooks to perform some formatting and linting before a commit is allowed.
That way, everyone uses the same style and some common issues can be caught early on.
Once installed, hooks will run when you commit. If the formatting isn't quite right or a linter catches something, the commit will be rejected.
You'll need to look at the output and fix the issue. Some hooks will format failing files, so all you need to do is `git add` those files again
and retry your commit.
## Service Widget Guidelines
To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets: