Skip to content

Commit

Permalink
Improve Contributing Docs (Flow) (#1461)
Browse files Browse the repository at this point in the history
* Improve the contribution docs by explaining how to setup VS Code with
  Flow support.
* Add .vscode folder to .gitignore.
  • Loading branch information
ITenthusiasm committed Mar 9, 2021
1 parent ca8269f commit 06f10e7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -9,3 +9,4 @@ coverage
lerna-debug.log
yarn-error.log
.idea
.vscode
14 changes: 14 additions & 0 deletions contributing.md
Expand Up @@ -40,3 +40,17 @@ Using karma (real browsers will get launched).
```bash
yarn test
```

## IDEs

If you are using VS Code, you'll need to do 2 things to get Flow type support:

1. Install the [Flow Language Support extension](https://marketplace.visualstudio.com/items?itemName=flowtype.flow-for-vscode).
2. If necessary, update your _local_ settings to disable JS file validation:

```JSON
// <PROJECT_ROOT>/.vscode/settings.json
{
"javascript.validate.enable": false
}
```

0 comments on commit 06f10e7

Please sign in to comment.