davide/palladum-lightning
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

doc: Add pre-commit section to Contributor Workflow documentation.

Browse Source
This commit is contained in:
Se7enZ
2025-12-10 13:34:26 +01:00
committed by Sangbida
parent 854dec008e
commit 2bc67c37c4
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/contribute-to-core-lightning/contributor-workflow.md
View File

@@ -61,6 +61,19 @@ uv build contrib/pyln-client/
uv build contrib/pyln-proto/
```
## Local checks with pre-commit
You can avoid common mistakes, speed up your development workflow and avoid wasteful CI runs by opting in to the local code checks managed by [pre-commit](https://pre-commit.com). The `pre-commit` Python package is part of the `dev` group and should be installed along with the other packages using `pip` or `uv` when [installing from source](https://docs.corelightning.org/docs/installation#installing-from-source). Activate it on your local development environment from the root of your Core Lightning working directory with:
```shell
pre-commit install
```
You can disable and remove it with:
```shell
pre-commit uninstall
pre-commit clean
```
## Making BOLT Modifications
All of code for marshalling/unmarshalling BOLT protocol messages is generated directly from the spec. These are pegged to the BOLTVERSION, as specified in `Makefile`.