_ 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, adversial thinking, thorough testing and risk-minimization.
  11 Any bug may cost users real money. That 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 [LDK slack](http://www.lightningdevkit.org/),
  19 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). Major milestones are tracked [here](https://github.com/rust-bitcoin/rust-lightning/milestones?direction=asc&sort=title&state=open).
  25
  26 Contribution Workflow
  27 ---------------------
  28
  29 The codebase is maintained using the "contributor workflow" where everyone
  30 without exception contributes patch proposals using "pull requests". This
  31 facilitates social contribution, easy testing and peer review.
  32
  33 To contribute a patch, the worflow is a as follows:
  34
  35   1. Fork Repository
  36   2. Create topic branch
  37   3. Commit patches
  38
  39 In general commits should be atomic and diffs should be easy to read.
  40 For this reason do not mix any formatting fixes or code moves with
  41 actual code changes. Further, each commit, individually, should compile
  42 and pass tests, in order to ensure git bisect and other automated tools
  43 function properly.
  44
  45 When adding a new feature, like implementing a BOLT spec object, thought
  46 must be given to the long term technical debt. Every new features should
  47 be covered by functional tests.
  48
  49 When refactoring, structure your PR to make it easy to review and don't
  50 hestitate to split it into multiple small, focused PRs.
  51
  52 The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis).
  53
  54 Commits should cover both issues fixed and solutions' rationale.
  55 These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
  56
  57 To facilitate communication with other contributors, if you are working on a GitHub Issue please assign it to yourself using GitHub's "assignee" field.
  58
  59 Peer review
  60 -----------
  61
  62 Anyone may participate in peer review which is expressed by comments in the pull
  63 request. Typically reviewers will review the code for obvious errors, as well as
  64 test out the patch set and opine on the technical merits of the patch. PR should
  65 be reviewed first on the conceptual level before focusing on code style or grammar
  66 fixes.
  67
  68 Coding Conventions
  69 ------------------
  70
  71 Use tabs. If you want to align lines, use spaces. Any desired alignment should
  72 display fine at any tab-length display setting.
  73
  74 Security
  75 --------
  76
  77 Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites
  78 helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning
  79 implementations, please inform them.
  80
  81 Note that Rust-Lightning is currently considered "pre-production" during this time, there
  82 is no special handling of security issues. Please simply open an issue on Github.
  83
  84 Testing
  85 -------
  86
  87 Related to the security aspect, Rust-Lightning developers take testing
  88 very seriously. Due to the modular nature of the project, writing new functional
  89 tests is easy and good test coverage of the codebase is an important goal. Refactoring
  90 the project to enable fine-grained unit testing is also an ongoing effort.
  91
  92 Fuzzing is heavily encouraged: you will find all related material under `fuzz/`
  93
  94 Mutation testing is work-in-progress; any contribution there would be warmly welcomed.
  95
  96 Going further
  97 -------------
  98
  99 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)
 100 and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
 101 While there are differences between the projects in terms of context and maturity, many of the suggestions offered apply to this project.
 102
 103 Overall, have fun :)