From 3c7bee3de0fe92201585c15ccedda3a19b623b25 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Mon, 24 May 2021 22:22:10 +0000 Subject: [PATCH] f clean up contributing wording --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 189f2b877..3cf463ba0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. -- 2.39.5