Skip to content

Commit

Permalink
docs: add missing docs about fixing linting errors (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
0x-r4bbit authored Sep 8, 2023
1 parent a7f2484 commit 6af96c0
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ These differences are:
- **Removal of [PRBTest](https://github.com/PaulRBerg/prb-test)** - In an attempt to keep dependence on third-party code
low, we've decided to remove this library as a standard dependency of every project within Vac. If we do see a need
for it, we might bring it back in the future.
- \*\*`PROPERTIES.md` - For invariant testing and formal verification, we've introduced a `PROPERTIES.md` to document
all protocol properties that must hold true.
- **PROPERTIES.md** - For invariant testing and formal verification, we've introduced a `PROPERTIES.md` to document all
protocol properties that must hold true.

### Sensible Defaults

Expand Down Expand Up @@ -169,6 +169,10 @@ Lint the contracts:
$ pnpm lint
```

#### Fixing linting issues

For any errors in solidity files, run `forge fmt`. For errors in any other file type, run `pnpm prettier:write`.

### Test

Run the tests:
Expand Down

0 comments on commit 6af96c0

Please sign in to comment.