From 5f31fef874eefc351fca1c9afca261658703934c Mon Sep 17 00:00:00 2001
From: Andy Balaam <andyb@element.io>
Date: Fri, 27 May 2022 20:08:41 +0100
Subject: [PATCH] Add documentation about how to run lint and fix dependencies
 (#8703)

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 7093c993e2..d44d9ff6e1 100644
--- a/README.md
+++ b/README.md
@@ -185,6 +185,29 @@ Ensure you've followed the above development instructions and then:
 yarn test
 ```
 
+### Running lint
+
+To check your code complies with the project style, ensure you've followed the
+above development instructions and then:
+
+```bash
+yarn lint
+```
+
+### Dependency problems
+
+If you see errors (particularly "Cannot find module") running the lint or test
+commands, and `yarn install` doesn't fix them, it may be because
+yarn is not fetching git dependencies eagerly enough.
+
+Try running this:
+
+```bash
+yarn cache clean && yarn install --force
+```
+
+Now the yarn commands should work as normal.
+
 ### End-to-End tests
 
 Make sure you've got your Element development server running (by doing `yarn