From 6dc1b0c9638ca86f7bb64f3a3e06d61a9f153f0c Mon Sep 17 00:00:00 2001 From: CJ42 Date: Thu, 14 Sep 2023 16:51:10 +0100 Subject: [PATCH] docs: add intro to comments in `CONTRIBUTING.md` --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92db00f36..9490584a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,6 +54,10 @@ When merging a branch to `develop` PRs should be squashed into one conventional ## Solidity Code Comments +A good level of documentation is crucial for understanding the intended behaviour of the smart contracts and for identifying any potential discrepancies between the implementation and the intended behaviour. + +When making contributions, each smart contracts and functions should be well-documented, with clear comments explaining the purpose and functionality of each function and module. + When changing or adding NatSpec comments to any `function`, `error` or `event` in any contract make sure to adhere to the following guidelines: 1. `@dev` and `@notice` tags can both contain text descriptions and two types of lists: bullet points or numbered lists. Make sure that those tags always start with text descriptions first, not with lists.