Store total payment amount in ClaimableHTLC explicitly
[rust-lightning] / CONTRIBUTING.md
index 186ae274fdacfcb165e7c0a9227f2837e12778c8..ab6ba2a410fb245c13fc1c7a6157a36448e9d07f 100644 (file)
@@ -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.
 
@@ -75,8 +75,7 @@ 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.
 
-The Minimal Supported Rust Version is 1.30.0 (enforced by our Travis and
-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.
@@ -114,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
 --------