Add note in CONTRIBUTING.md that some structs need prefix/suffixes
authorMatt Corallo <git@bluematt.me>
Thu, 20 May 2021 20:09:29 +0000 (20:09 +0000)
committerMatt Corallo <git@bluematt.me>
Tue, 25 May 2021 20:06:45 +0000 (20:06 +0000)
CONTRIBUTING.md

index 9ddd792b238c57dae399b19d0d1a7abf86e12181..3cf463ba02e220b7f1e12605398c344fc3d79628 100644 (file)
@@ -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
 --------