_ 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 Contribution Workflow
  28 ---------------------
  29
  30 The codebase is maintained using the "contributor workflow" where everyone
  31 without exception contributes patch proposals using "pull requests". This
  32 facilitates social contribution, easy testing and peer review.
  33
  34 To contribute a patch, the worflow is a as follows:
  35
  36   1. Fork Repository
  37   2. Create topic branch
  38   3. Commit patches
  39
  40 In general commits should be atomic and diffs should be easy to read.
  41 For this reason do not mix any formatting fixes or code moves with
  42 actual code changes. Further, each commit, individually, should compile
  43 and pass tests, in order to ensure git bisect and other automated tools
  44 function properly.
  45
  46 When adding a new feature, like implementing a BOLT spec object, thought
  47 must be given to the long term technical debt. Every new features should
  48 be covered by functional tests.
  49
  50 When refactoring, structure your PR to make it easy to review and don't
  51 hestitate to split it into multiple small, focused PRs.
  52
  53 The Minimal Supported Rust Version is 1.30.0 (enforced by our Travis and
  54 GitHub Actions).
  55
  56 Commits should cover both the issue fixed and the solution's rationale.
  57 These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
  58
  59 To facilitate communication with other contributors, the project is making use of
  60 GitHub's "assignee" field. First check that no one is assigned and then comment
  61 suggesting that you're working on it. If someone is already assigned, don't hesitate
  62 to ask if the assigned party or previous commenters are still working on it if it has
  63 been awhile.
  64
  65 Peer review
  66 -----------
  67
  68 Anyone may participate in peer review which is expressed by comments in the pull
  69 request. Typically reviewers will review the code for obvious errors, as well as
  70 test out the patch set and opine on the technical merits of the patch. PR should
  71 be reviewed first on the conceptual level before focusing on code style or grammar
  72 fixes.
  73
  74 Coding Conventions
  75 ------------------
  76
  77 Use tabs. If you want to align lines, use spaces. Any desired alignment should
  78 display fine at any tab-length display setting.
  79
  80 Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default linting
  81 [settings](https://rust-lang.github.io/rust-clippy/rust-1.39.0/index.html).
  82 This includes all lint groups except for nursery, pedantic, and cargo in addition to allowing the following lints:
  83 `erasing_op`, `never_loop`, `if_same_then_else`.
  84
  85 If you use rustup, feel free to lint locally, otherwise you can just push to CI for automated linting.
  86
  87 ```bash
  88 rustup component add clippy
  89 cargo clippy
  90 ```
  91
  92 Security
  93 --------
  94
  95 Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites
  96 helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning
  97 implementations, please inform them.
  98
  99 Note that Rust-Lightning is currently considered "pre-production" during this time, there
 100 is no special handling of security issues. Please simply open an issue on Github.
 101
 102 Testing
 103 -------
 104
 105 Related to the security aspect, Rust-Lightning developers take testing
 106 very seriously. Due to the modular nature of the project, writing new functional
 107 tests is easy and good test coverage of the codebase is an important goal. Refactoring
 108 the project to enable fine-grained unit testing is also an ongoing effort.
 109
 110 Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
 111
 112 Mutation testing is work-in-progress; any contribution there would be warmly welcomed.
 113
 114 C/C++ Bindings
 115 --------------
 116
 117 You can learn more about the C/C++ bindings that are made available by reading the
 118 [C/C++ Bindings README](lightning-c-bindings/README.md). If you are not using the C/C++ bindings,
 119 you likely don't need to worry about them, and during their early experimental phase we are not
 120 requiring that pull requests keep the bindings up to date (and, thus, pass the bindings_check CI
 121 run). If you wish to ensure your PR passes the bindings generation phase, you should run the
 122 `genbindings.sh` script in the top of the directory tree to generate, build, and test C bindings on
 123 your local system.
 124
 125 Going further
 126 -------------
 127
 128 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)
 129 and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
 130 While there are differences between the projects in terms of context and maturity, many
 131 of the suggestions offered apply to this project.
 132
 133 Overall, have fun :)