LadybirdBrowser/ladybird
1
1
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-08-16 17:00:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

Meta: Add a note about commit hooks to the contribution guide

Browse Source 
These are pretty useful but are not documented anywhere, so this should
fix that :^)
This commit is contained in:
Idan Horowitz 2021-07-06 18:50:20 +03:00 committed by Linus Groh
parent 83f61748a5
commit 7d40987ab6
Notes: sideshowbarker 2024-07-18 10:17:03 +09:00 
Author: https://github.com/IdanHo
Commit: https://github.com/SerenityOS/serenity/commit/7d40987ab62
Pull-request: https://github.com/SerenityOS/serenity/pull/8500
Reviewed-by: https://github.com/MaxWipfli ✅
Reviewed-by: https://github.com/linusg ✅
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -88,3 +88,16 @@ In theory, the best person to speak with is whoever wrote most code adjacent to
### Is Discord the place to ask for review help, or is Github preferred?
It's definitely better to ask on Discord. Due to the volume of GitHub notifications, many of us turn them off and rely on Discord for learning about review requests.
## Commit Hooks
The repository contains a file called `.pre-commit-config.yaml` that defines several 'commit hooks' that can be run automatically just before and after creating a new commit. These hooks lint your commit message, and the changes it contains to ensure they will pass the automated CI for pull requests.
To enable these hooks firstly follow the installation instructions available at https://pre-commit.com/#install and then enable one or both of the following hooks:
- pre-commit hook - Runs Meta/lint-ci.sh and Meta/lint-ports.py to ensure changes to the code will pass linting:
```console
pre-commit install
```
- post-commit hook - Lints the commit message to ensure it will pass the commit linting:
```console
pre-commit install --hook-type commit-msg
```