X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=e2c5252dc6ff4213cddb0d2c21ee184471e2b952;hb=65920818db58880f6576fd50c3ea5df273912978;hp=9ddd792b238c57dae399b19d0d1a7abf86e12181;hpb=affefb677e3f9f1a586707484ac82b6c86f4f26b;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ddd792b..e2c5252d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,8 +21,8 @@ Communication about Rust-Lightning happens primarily on #ldk-dev on the Discussion about code base improvements happens in GitHub issues and on pull requests. -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). +Major projects are tracked [here](https://github.com/lightningdevkit/rust-lightning/projects). +Major milestones are tracked [here](https://github.com/lightningdevkit/rust-lightning/milestones?direction=asc&sort=title&state=open). Getting Started --------------- @@ -33,7 +33,7 @@ This doesn't mean don't be ambitious with the breadth and depth of your contribu 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/rust-bitcoin/rust-lightning/wiki/Meetings) +Browsing through the [meeting minutes](https://github.com/lightningdevkit/rust-lightning/wiki/Meetings) 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. @@ -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,9 @@ 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 is 1.41.1 (enforced by our GitHub Actions). 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. @@ -113,6 +113,14 @@ rustup component add clippy cargo clippy ``` +Significant structures that users persist should always have their serialization methods (usually +`Writeable::write` and `ReadableArgs::read`) begin with +`write_ver_prefix!()`/`read_ver_prefix!()` calls, and end with calls to +`write_tlv_fields!()`/`read_tlv_fields!()`. + +Updates to the serialized format which has implications for backwards or forwards compatibility +must be included in release notes. + Security --------