git.bitcoin.ninja 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, documentation,
   6 testing and patches.
   7
   8 Anyone is invited to contribute without regard to technical experience, "expertise", OSS
   9 experience, age, or other concern. However, the development of cryptocurrencies demands a
  10 high-level of rigor, adversarial thinking, thorough testing and risk-minimization.
  11 Any bug may cost users real money. That being said, we deeply welcome people contributing
  12 for the first time to an open source project or pick up Rust while contributing. Don't be shy,
  13 you'll learn.
  14
  15 Communications Channels
  16 -----------------------
  17
  18 Communication about Rust-Lightning happens primarily on #ldk-dev on the
  19 [LDK slack](http://www.lightningdevkit.org/), but also #rust-bitcoin on IRC Freenode.
  20
  21 Discussion about code base improvements happens in GitHub issues and on pull
  22 requests.
  23
  24 Major projects are tracked [here](https://github.com/rust-bitcoin/rust-lightning/projects).
  25 Major milestones are tracked [here](https://github.com/rust-bitcoin/rust-lightning/milestones?direction=asc&sort=title&state=open).
  26
  27 Getting Started
  28 ---------------
  29
  30 First and foremost, start small.
  31
  32 This doesn't mean don't be ambitious with the breadth and depth of your contributions but rather
  33 understand the project context and culture before investing an asymmetric number of hours on
  34 development compared to your merged work.
  35
  36 Even if you have an extensive open source background or sound software engineering skills, consider
  37 that the reviewers' comprehension of the code is as much important as technical correctness.
  38
  39 It's very welcome to ask for review, either on IRC or LDK Slack. And also for reviewers, it's nice
  40 to provide timelines when you hope to fulfill the request while bearing in mind for both sides that's
  41 a "soft" commitment.
  42
  43 If you're eager to increase the velocity of the dev process, reviewing other contributors work is
  44 the best you can do while waiting review on yours.
  45
  46 Contribution Workflow
  47 ---------------------
  48
  49 The codebase is maintained using the "contributor workflow" where everyone
  50 without exception contributes patch proposals using "pull requests". This
  51 facilitates social contribution, easy testing and peer review.
  52
  53 To contribute a patch, the worflow is a as follows:
  54
  55   1. Fork Repository
  56   2. Create topic branch
  57   3. Commit patches
  58
  59 In general commits should be atomic and diffs should be easy to read.
  60 For this reason do not mix any formatting fixes or code moves with
  61 actual code changes. Further, each commit, individually, should compile
  62 and pass tests, in order to ensure git bisect and other automated tools
  63 function properly.
  64
  65 When adding a new feature, like implementing a BOLT spec object, thought
  66 must be given to the long term technical debt. Every new features should
  67 be covered by functional tests.
  68
  69 When refactoring, structure your PR to make it easy to review and don't
  70 hestitate to split it into multiple small, focused PRs.
  71
  72 The Minimal Supported Rust Version is 1.30.0 (enforced by our Travis and
  73 GitHub Actions).
  74
  75 Commits should cover both the issue fixed and the solution's rationale.
  76 These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
  77
  78 To facilitate communication with other contributors, the project is making use of
  79 GitHub's "assignee" field. First check that no one is assigned and then comment
  80 suggesting that you're working on it. If someone is already assigned, don't hesitate
  81 to ask if the assigned party or previous commenters are still working on it if it has
  82 been awhile.
  83
  84 Peer review
  85 -----------
  86
  87 Anyone may participate in peer review which is expressed by comments in the pull
  88 request. Typically reviewers will review the code for obvious errors, as well as
  89 test out the patch set and opine on the technical merits of the patch. PR should
  90 be reviewed first on the conceptual level before focusing on code style or grammar
  91 fixes.
  92
  93 Coding Conventions
  94 ------------------
  95
  96 Use tabs. If you want to align lines, use spaces. Any desired alignment should
  97 display fine at any tab-length display setting.
  98
  99 Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default linting
 100 [settings](https://rust-lang.github.io/rust-clippy/rust-1.39.0/index.html).
 101 This includes all lint groups except for nursery, pedantic, and cargo in addition to allowing the following lints:
 102 `erasing_op`, `never_loop`, `if_same_then_else`.
 103
 104 If you use rustup, feel free to lint locally, otherwise you can just push to CI for automated linting.
 105
 106 ```bash
 107 rustup component add clippy
 108 cargo clippy
 109 ```
 110
 111 Security
 112 --------
 113
 114 Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites
 115 helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning
 116 implementations, please inform them.
 117
 118 Note that Rust-Lightning is currently considered "pre-production" during this time, there
 119 is no special handling of security issues. Please simply open an issue on Github.
 120
 121 Testing
 122 -------
 123
 124 Related to the security aspect, Rust-Lightning developers take testing
 125 very seriously. Due to the modular nature of the project, writing new functional
 126 tests is easy and good test coverage of the codebase is an important goal. Refactoring
 127 the project to enable fine-grained unit testing is also an ongoing effort.
 128
 129 Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
 130
 131 Mutation testing is work-in-progress; any contribution there would be warmly welcomed.
 132
 133 C/C++ Bindings
 134 --------------
 135
 136 You can learn more about the C/C++ bindings that are made available by reading the
 137 [C/C++ Bindings README](lightning-c-bindings/README.md). If you are not using the C/C++ bindings,
 138 you likely don't need to worry about them, and during their early experimental phase we are not
 139 requiring that pull requests keep the bindings up to date (and, thus, pass the bindings_check CI
 140 run). If you wish to ensure your PR passes the bindings generation phase, you should run the
 141 `genbindings.sh` script in the top of the directory tree to generate, build, and test C bindings on
 142 your local system.
 143
 144 Going further
 145 -------------
 146
 147 You may be interested by Jon Atack guide on [How to review Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-review-bitcoin-core-prs.md)
 148 and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
 149 While there are differences between the projects in terms of context and maturity, many
 150 of the suggestions offered apply to this project.
 151
 152 Overall, have fun :)