From: Matt Corallo <git@bluematt.me>
Date: Thu, 20 May 2021 20:09:29 +0000 (+0000)
Subject: Add note in CONTRIBUTING.md that some structs need prefix/suffixes
X-Git-Tag: v0.0.98~18^2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=bdb2d220e85e29779475a7ba172835404dea3e98;p=rust-lightning

Add note in CONTRIBUTING.md that some structs need prefix/suffixes
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9ddd792b2..3cf463ba0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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
 --------