]> git.bitcoin.ninja Git - rust-lightning/blob - CONTRIBUTING.md
Split finalize_package into separate methods per malleability
[rust-lightning] / CONTRIBUTING.md
1 Contributing to Rust-Lightning
2 ==============================
3
4 The `rust-lightning` project operates an open contributor model where anyone is
5 welcome to contribute towards development in the form of peer review,
6 documentation, testing and patches.
7
8 Anyone is invited to contribute without regard to technical experience,
9 "expertise", OSS experience, age, or other concern. However, the development of
10 cryptocurrencies demands a high-level of rigor, adversarial thinking, thorough
11 testing and risk-minimization. Any bug may cost users real money. That being
12 said, we deeply welcome people contributing for the first time to an open source
13 project or pick up Rust while contributing. Don't be shy, you'll learn.
14
15 Communication Channels
16 -----------------------
17
18 Communication about the development of LDK and `rust-lightning` happens
19 primarily on the [LDK Discord](https://discord.gg/5AcknnMfBw) in the `#ldk-dev`
20 channel. Additionally, live LDK devevelopment meetings are held every other
21 Monday 19:00 UTC in the [LDK Dev Jitsi Meeting
22 Room](https://meet.jit.si/ldkdevmeeting). Upcoming events can be found in the
23 [LDK calendar](https://calendar.google.com/calendar/embed?src=c_e6fv6vlshbpoob2mmbvblkkoj4%40group.calendar.google.com).
24
25 Contributors starting out with the Rust language are welcome to discuss and ask
26 for help in the `#rust-101` channel on LDK Discord.
27
28 Discussion about code base improvements happens in GitHub issues and on pull
29 requests.
30
31 The LDK roadmap is tracked [here](https://github.com/orgs/lightningdevkit/projects/2).
32
33 Major milestones are tracked [here](https://github.com/lightningdevkit/rust-lightning/milestones?direction=asc&sort=title&state=open).
34
35 Getting Started
36 ---------------
37
38 First and foremost, start small.
39
40 This doesn't mean don't be ambitious with the breadth and depth of your
41 contributions but rather understand the project culture before investing an
42 asymmetric number of hours on development compared to your merged work.
43
44 Browsing through the [meeting minutes](https://github.com/lightningdevkit/rust-lightning/wiki/Meetings)
45 is a good first step. You will learn who is working on what, how releases are
46 drafted, what are the pending tasks to deliver, where you can contribute review
47 bandwidth, etc.
48
49 Even if you have an extensive open source background or sound software
50 engineering skills, consider that the reviewers' comprehension of the code is as
51 much important as technical correctness.
52
53 It's very welcome to ask for review on LDK Discord. And also for reviewers, it's
54 nice to provide timelines when you hope to fulfill the request while bearing in
55 mind for both sides that's a "soft" commitment.
56
57 If you're eager to increase the velocity of the dev process, reviewing other
58 contributors work is the best you can do while waiting review on yours.
59
60 Also, getting familiar with the [glossary](GLOSSARY.md) will streamline
61 discussions with regular contributors.
62
63 Contribution Workflow
64 ---------------------
65
66 The codebase is maintained using the "contributor workflow" where everyone
67 without exception contributes patch proposals using "pull requests". This
68 facilitates social contribution, easy testing and peer review.
69
70 To contribute a patch, the workflow is as follows:
71
72   1. Fork Repository
73   2. Create topic branch
74   3. Commit patches
75
76 In general commits should be atomic and diffs should be easy to read.
77 For this reason do not mix any formatting fixes or code moves with
78 actual code changes. Further, each commit, individually, should compile
79 and pass tests, in order to ensure git bisect and other automated tools
80 function properly.
81
82 When adding a new feature, like implementing a BOLT spec object, thought
83 must be given to the long term technical debt. Every new features should
84 be covered by functional tests.
85
86 When refactoring, structure your PR to make it easy to review and don't
87 hesitate to split it into multiple small, focused PRs.
88
89 The Minimum Supported Rust Version (MSRV) currently is 1.41.1 (enforced by
90 our GitHub Actions). Also, the compatibility for LDK object serialization is
91 currently ensured back to and including crate version 0.0.99 (see the
92 [changelog](CHANGELOG.md)).
93
94 Commits should cover both the issue fixed and the solution's rationale. These
95 [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
96
97 To facilitate communication with other contributors, the project is making use
98 of GitHub's "assignee" field. First check that no one is assigned and then
99 comment suggesting that you're working on it. If someone is already assigned,
100 don't hesitate to ask if the assigned party or previous commenters are still
101 working on it if it has been awhile.
102
103 Any changes that have nontrivial backwards compatibility considerations should
104 have an entry added in the `pending_changelog` folder which includes the
105 CHANGELOG entries that should be added in the next release.
106
107 Peer review
108 -----------
109
110 Anyone may participate in peer review which is expressed by comments in the pull
111 request. Typically reviewers will review the code for obvious errors, as well as
112 test out the patch set and opine on the technical merits of the patch. PR should
113 be reviewed first on the conceptual level before focusing on code style or
114 grammar fixes.
115
116 Coding Conventions
117 ------------------
118
119 Use tabs. If you want to align lines, use spaces. Any desired alignment should
120 display fine at any tab-length display setting.
121
122 Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
123 linting
124 [settings](https://rust-lang.github.io/rust-clippy/rust-1.39.0/index.html). This
125 includes all lint groups except for nursery, pedantic, and cargo in addition to
126 allowing the following lints: `erasing_op`, `never_loop`, `if_same_then_else`.
127
128 If you use rustup, feel free to lint locally, otherwise you can just push to CI
129 for automated linting.
130
131 ```bash
132 rustup component add clippy
133 cargo clippy
134 ```
135
136 Significant structures that users persist should always have their serialization
137 methods (usually `Writeable::write` and `ReadableArgs::read`) begin with
138 `write_ver_prefix!()`/`read_ver_prefix!()` calls, and end with calls to
139 `write_tlv_fields!()`/`read_tlv_fields!()`.
140
141 Updates to the serialized format which has implications for backwards or
142 forwards compatibility must be included in release notes.
143
144 Security
145 --------
146
147 Security is the primary focus of `rust-lightning`; disclosure of security
148 vulnerabilites helps prevent user loss of funds. If you believe a vulnerability
149 may affect other Lightning implementations, please inform them.
150
151 You can find further information on submitting (possible) vulnerabilities in the
152 [security policy](SECURITY.md).
153
154 Testing
155 -------
156
157 Related to the security aspect, `rust-lightning` developers take testing very
158 seriously. Due to the modular nature of the project, writing new functional
159 tests is easy and good test coverage of the codebase is an important goal.
160 Refactoring the project to enable fine-grained unit testing is also an ongoing
161 effort.
162
163 Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
164
165 Mutation testing is work-in-progress; any contribution there would be warmly
166 welcomed.
167
168 C/C++ Bindings
169 --------------
170
171 You can learn more about the C/C++ bindings that are made available by reading
172 the [C/C++ Bindings README](https://github.com/lightningdevkit/ldk-c-bindings/blob/main/lightning-c-bindings/README.md).
173 If you are not using the C/C++ bindings, you likely don't need to worry about
174 them, and during their early experimental phase we are not requiring that pull
175 requests keep the bindings up to date (and, thus, pass the `bindings_check` CI
176 run). If you wish to ensure your PR passes the bindings generation phase, you
177 should run the `genbindings.sh` script in the top of the directory tree to
178 generate, build, and test C bindings on your local system.
179
180 Going further
181 -------------
182
183 You may be interested by Jon Atack's guide on [How to review Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-review-bitcoin-core-prs.md)
184 and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
185 While there are differences between the projects in terms of context and
186 maturity, many of the suggestions offered apply to this project.
187
188 Overall, have fun :)