Skip to content

Commit

Permalink
fix(docs): typo in contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
omahs authored Dec 1, 2022
1 parent 69e9362 commit 5bed261
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you are opening a new issue, try to be descriptive as possible. Also please c

### Source code comments

Follow the [NatSpec format](https://docs.soliditylang.org/en/v0.8.16/natspec-format.html) for documentating smart contract source code. Please adhere to a few additional standards:
Follow the [NatSpec format](https://docs.soliditylang.org/en/v0.8.16/natspec-format.html) for documenting smart contract source code. Please adhere to a few additional standards:

- Choose `/** */` over `///` for multi-line NatSpec comments, to save column space
- Omit the usage of `@notice`, this will be automatically picked up so it will save column space and improve readability
Expand Down

0 comments on commit 5bed261

Please sign in to comment.