X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=93666dd22970d0bbeb2dedc206fa2f484d956586;hb=79b55f081557f7df7fc27f6c39574904bdbd1737;hp=2c1fb0d8a7376db6a0b7624fa8d0c0583423c64c;hpb=b62b244c3c826523a81631037cd060bafef8e402;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c1fb0d8..93666dd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,7 @@ The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests". This facilitates social contribution, easy testing and peer review. -To contribute a patch, the worflow is a as follows: +To contribute a patch, the workflow is as follows: 1. Fork Repository 2. Create topic branch @@ -73,9 +73,12 @@ must be given to the long term technical debt. Every new features should be covered by functional tests. When refactoring, structure your PR to make it easy to review and don't -hestitate to split it into multiple small, focused PRs. +hesitate to split it into multiple small, focused PRs. -The Minimal Supported Rust Version is 1.36.0 (enforced by our GitHub Actions). +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)). 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.