Skip to content

Commit 2a39948

Browse files
committed
doc: Add pre-commit section to Contributor Workflow documentation.
1 parent 6d3e050 commit 2a39948

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/contribute-to-core-lightning/contributor-workflow.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,19 @@ uv build contrib/pyln-client/
6161
uv build contrib/pyln-proto/
6262
```
6363

64+
## Local checks with pre-commit
65+
66+
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:
67+
```shell
68+
pre-commit install
69+
```
70+
71+
You can disable and remove it with:
72+
```shell
73+
pre-commit uninstall
74+
pre-commit clean
75+
```
76+
6477
## Making BOLT Modifications
6578

6679
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`.

0 commit comments

Comments
 (0)