From 6af96c0556555ab0fbf26edcae3fa12abbc35704 Mon Sep 17 00:00:00 2001
From: r4bbit <445106+0x-r4bbit@users.noreply.github.com>
Date: Fri, 8 Sep 2023 21:42:27 +0200
Subject: [PATCH] docs: add missing docs about fixing linting errors (#7)

---
 README.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1342a53..ed10bf5 100644
--- a/README.md
+++ b/README.md
@@ -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
 
@@ -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: