docs(codestyle): String() string methods (ChainSafe#1965)

timwu20 · Dec 6, 2021 · 4e049d1 · 4e049d1
1 parent 6098ff1
commit 4e049d1
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/.github/CODE_STYLE.md b/.github/CODE_STYLE.md
@@ -1,3 +1,8 @@
 # Code style
 
 🚧 work in progress! 🚧
+
+## Add `String() string` methods
+
+Add `String() string` methods to new types, so they can easily be logged.
+💁 You should try de-referencing pointer fields in your method, to avoid logging pointer addresses.