Skip to content

Improve Contributing Docs (Flow) #1461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kof merged 1 commit into from
Mar 9, 2021
Merged

Improve Contributing Docs (Flow) #1461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ coverage
lerna-debug.log
yarn-error.log
.idea
.vscode
14 changes: 14 additions & 0 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,17 @@ Using karma (real browsers will get launched).
```bash
yarn test
```

## IDEs
Copy link
Copy Markdown
Member

@kof kof Mar 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is about adding general flowtype to vscode ... how is this related to JSS project?

I think we should add documentation that specifically helps with JSS related problems

Copy link
Copy Markdown
Member

@kof kof Mar 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One doesn't even need ide integration to contribute to JSS, one can run flow over console ...


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
}
```
⚡