Skip to content

Commit

Permalink
Merge pull request #718 from lukso-network/docs/contribution-guidelines
Browse files Browse the repository at this point in the history
docs: add intro to comments in `CONTRIBUTING.md` from C4
  • Loading branch information
CJ42 authored Sep 15, 2023
2 parents 98cb6c3 + 6dc1b0c commit c4d1a6f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c4d1a6f

Please sign in to comment.