From bdb2d220e85e29779475a7ba172835404dea3e98 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Thu, 20 May 2021 20:09:29 +0000 Subject: [PATCH] Add note in CONTRIBUTING.md that some structs need prefix/suffixes --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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 -------- -- 2.39.5