From 1bc041e71f5d7fbd22a71841279f140bee10f8e8 Mon Sep 17 00:00:00 2001 From: danwt <30197399+danwt@users.noreply.github.com> Date: Thu, 7 Nov 2024 17:01:09 +0000 Subject: [PATCH] finally --- Contributing.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Contributing.md b/Contributing.md index b57f412f2..4f9488fb2 100644 --- a/Contributing.md +++ b/Contributing.md @@ -185,6 +185,21 @@ It's encouraged to add golang and cosmos utilities and shared code to [dymension 2. Do not reuse protobuf field numbers when updating protos. When in doubt, reserve the old number and use a new one. +#### Docstrings + +Do not worry about making the first word of the docstring on a public object the same as the object. Feel free to disable any linters/highlighters that pick up on it. + +In other words, we are fine with the first version here: + +```go + +// bla bla +type Foo struct{ } + +// Foo bla bla +type Foo struct{ } +``` + ### References - https://github.com/dymensionxyz/sdk-utils : Dymension golang and SDK utils library