From 9664be921c4b1d67eee4905640c6ac41fe31ca39 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 | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ddd792b2..189f2b877 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,6 +113,13 @@ 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. + +Updates to the serialized format which has implications for backwards or forwards compatibility +must be included in release notes. + Security -------- -- 2.39.5