Skip to content

Commit

Permalink
chore: udpate comments seciton in styleguide (#14435)
Browse files Browse the repository at this point in the history
  • Loading branch information
RayXpub authored Sep 16, 2024
1 parent 9328ed8 commit 530207e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion contracts/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ We will be looking into `forge fmt`, but for now, we still use `prettier`.
This will help massively during audits and onboarding new team members.
- Headers should be used to group functionality, the following header style and length are recommended.
- Don’t use headers for a single function, or to say “getters”. Group by functionality e.g. the `Tokens and pools`, or `fees` logic within the CCIP OnRamp.
- Comments should start with a capital letter and end with a period.

```solidity
// ================================================================
Expand Down Expand Up @@ -419,4 +420,3 @@ function setConfig(uint64 _foo, uint64 _bar, uint64 _baz) external {
```

rule: `tbd`

0 comments on commit 530207e

Please sign in to comment.