Skip to content

Commit 83322e1

Browse files
committed
Add developer guideline notes for C/C++ bindings generation
1 parent 253af8d commit 83322e1

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,17 @@ Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
9999

100100
Mutation testing is work-in-progress; any contribution there would be warmly welcomed.
101101

102+
C/C++ Bindings
103+
--------------
104+
105+
You can learn more about the C/C++ bindings that are made available by reading the
106+
[C/C++ Bindings README](lightning-c-bindings/README.md). If you are not using the C/C++ bindings,
107+
you likely don't need to worry about them, and during their early experimental phase we are not
108+
requiring that pull requests keep the bindings up to date (and, thus, pass the bindings_check CI
109+
run). If you wish to ensure your PR passes the bindings generation phase, you should run the
110+
`genbindings.sh` script in the top of the directory tree to generate, build, and test C bindings on
111+
your local system.
112+
102113
Going further
103114
-------------
104115

0 commit comments

Comments
 (0)