]> git.bitcoin.ninja Git - rust-lightning/commitdiff
f clean up contributing wording 2021-05-tlv-ser
authorMatt Corallo <git@bluematt.me>
Mon, 24 May 2021 22:22:10 +0000 (22:22 +0000)
committerMatt Corallo <git@bluematt.me>
Mon, 24 May 2021 22:25:04 +0000 (22:25 +0000)
CONTRIBUTING.md

index 189f2b8777920a8a762869b456a4b6c60489fcc5..3cf463ba02e220b7f1e12605398c344fc3d79628 100644 (file)
@@ -113,9 +113,10 @@ rustup component add clippy
 cargo clippy
 ```
 
-Significant structures which users serialize and store should generally always be prefixed with
-`write_ver_prefix!()`/`read_ver_prefix!()` calls, and suffixed with
-`write_tlv_fields!()`/`read_tlv_fields!()` calls.
+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.