_ 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.22.0 (enforced by our Travis).
  54
  55 Commits should cover both the issue fixed and the solution's rationale.
  56 These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
  57
  58 To facilitate communication with other contributors, the project is making use of
  59 GitHub's "assignee" field. First check that no one is assigned and then comment
  60 suggesting that you're working on it. If someone is already assigned, don't hesitate
  61 to ask if the assigned party or previous commenters are still working on it if it has
  62 been awhile.
  63
  64 Peer review
  65 -----------
  66
  67 Anyone may participate in peer review which is expressed by comments in the pull
  68 request. Typically reviewers will review the code for obvious errors, as well as
  69 test out the patch set and opine on the technical merits of the patch. PR should
  70 be reviewed first on the conceptual level before focusing on code style or grammar
  71 fixes.
  72
  73 Coding Conventions
  74 ------------------
  75
  76 Use tabs. If you want to align lines, use spaces. Any desired alignment should
  77 display fine at any tab-length display setting.
  78
  79 Security
  80 --------
  81
  82 Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites
  83 helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning
  84 implementations, please inform them.
  85
  86 Note that Rust-Lightning is currently considered "pre-production" during this time, there
  87 is no special handling of security issues. Please simply open an issue on Github.
  88
  89 Testing
  90 -------
  91
  92 Related to the security aspect, Rust-Lightning developers take testing
  93 very seriously. Due to the modular nature of the project, writing new functional
  94 tests is easy and good test coverage of the codebase is an important goal. Refactoring
  95 the project to enable fine-grained unit testing is also an ongoing effort.
  96
  97 Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
  98
  99 Mutation testing is work-in-progress; any contribution there would be warmly welcomed.
 100
 101 Going further
 102 -------------
 103
 104 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)
 105 and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
 106 While there are differences between the projects in terms of context and maturity, many
 107 of the suggestions offered apply to this project.
 108
 109 Overall, have fun :)