Skip to content

Commit bdb2d22

Browse files
committed
Add note in CONTRIBUTING.md that some structs need prefix/suffixes
1 parent 02c57f5 commit bdb2d22

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ rustup component add clippy
113113
cargo clippy
114114
```
115115

116+
Significant structures that users persist should always have their serialization methods (usually
117+
`Writeable::write` and `ReadableArgs::read`) begin with
118+
`write_ver_prefix!()`/`read_ver_prefix!()` calls, and end with calls to
119+
`write_tlv_fields!()`/`read_tlv_fields!()`.
120+
121+
Updates to the serialized format which has implications for backwards or forwards compatibility
122+
must be included in release notes.
123+
116124
Security
117125
--------
118126

0 commit comments

Comments
 (0)