X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=b57217165e6b79c239351ebeef85647bafdab18a;hb=refs%2Fheads%2F2024-01-121-bindings;hp=6f12c21e9f9d6c9035d3225316d3e5ed42b5d3eb;hpb=554fc02ed230e48bbe163d8ee065be9626ed1d0f;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f12c21e..b5721716 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,8 @@ testing and risk-minimization. Any bug may cost users real money. That being said, we deeply welcome people contributing for the first time to an open source project or pick up Rust while contributing. Don't be shy, you'll learn. +For the project Code of Conduct, see our [website](https://lightningdevkit.org/code_of_conduct). + Communication Channels ----------------------- @@ -41,7 +43,7 @@ This doesn't mean don't be ambitious with the breadth and depth of your contributions but rather understand the project culture before investing an asymmetric number of hours on development compared to your merged work. -Browsing through the [meeting minutes](https://github.com/lightningdevkit/rust-lightning/wiki/Meetings) +Browsing through the [meeting minutes](https://github.com/lightningdevkit/rust-lightning/wiki/Meeting-Notes) is a good first step. You will learn who is working on what, how releases are drafted, what are the pending tasks to deliver, where you can contribute review bandwidth, etc. @@ -86,10 +88,11 @@ be covered by functional tests. When refactoring, structure your PR to make it easy to review and don't hesitate to split it into multiple small, focused PRs. -The Minimum Supported Rust Version (MSRV) currently is 1.41.1 (enforced by -our GitHub Actions). Also, the compatibility for LDK object serialization is -currently ensured back to and including crate version 0.0.99 (see the -[changelog](CHANGELOG.md)). +The Minimum Supported Rust Version (MSRV) currently is 1.63.0 (enforced by +our GitHub Actions). We support reading serialized LDK objects written by any +version of LDK 0.0.99 and above. We support LDK versions 0.0.113 and above +reading serialized LDK objects written by modern LDK. Any expected issues with +upgrades or downgrades should be mentioned in the [changelog](CHANGELOG.md). Commits should cover both the issue fixed and the solution's rationale. These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind. @@ -145,7 +148,7 @@ Security -------- Security is the primary focus of `rust-lightning`; disclosure of security -vulnerabilites helps prevent user loss of funds. If you believe a vulnerability +vulnerabilities helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning implementations, please inform them. You can find further information on submitting (possible) vulnerabilities in the