Skip to content
This repository was archived by the owner on Sep 11, 2024. It is now read-only.

Commit 5f31fef

Browse files
authored
Add documentation about how to run lint and fix dependencies (#8703)
1 parent f47121e commit 5f31fef

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,29 @@ Ensure you've followed the above development instructions and then:
185185
yarn test
186186
```
187187

188+
### Running lint
189+
190+
To check your code complies with the project style, ensure you've followed the
191+
above development instructions and then:
192+
193+
```bash
194+
yarn lint
195+
```
196+
197+
### Dependency problems
198+
199+
If you see errors (particularly "Cannot find module") running the lint or test
200+
commands, and `yarn install` doesn't fix them, it may be because
201+
yarn is not fetching git dependencies eagerly enough.
202+
203+
Try running this:
204+
205+
```bash
206+
yarn cache clean && yarn install --force
207+
```
208+
209+
Now the yarn commands should work as normal.
210+
188211
### End-to-End tests
189212

190213
Make sure you've got your Element development server running (by doing `yarn

0 commit comments

Comments
 (0)