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