Skip to content

Commit b7d70ee

Browse files
authored
Merge pull request #63 from 8iq/refactor-documentation
refactor documentation
2 parents 60b2727 + afb8041 commit b7d70ee

File tree

2 files changed

+24
-23
lines changed

2 files changed

+24
-23
lines changed

docs/contributing.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,30 @@
55
3. Write tests
66
4. Make a pull-request to the core repo
77

8-
# Project features and feature requests
8+
## linter
9+
10+
We use [eslint](https://eslint.org) as our linter. It enforces code-style and best-practices
11+
12+
We don't allow bad code into the repo. To ensure this we run [eslint](https://eslint.org) on `CI`.
13+
14+
The configuration for the [eslint](https://eslint.org) is found under `package.json`
15+
16+
**Available CLI-commands:**
17+
18+
- `yarn lint` lint whole project <- this command runs on CI
19+
- `yarn run eslint <directory>` check files in `<directory>`
20+
- `yarn run eslint --fix <directory>` check files in `<directory>` and fix them if possible
21+
22+
**Editor integrations:**
23+
24+
[Webstorm integration:](https://plugins.jetbrains.com/plugin/7494-eslint)
25+
26+
[VSCode integration:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
27+
28+
[Other editors](https://eslint.org/docs/user-guide/integrations#editors)
29+
30+
31+
# Project features and feature requests.
932

1033
Features that aren't checked are available to take
1134

docs/getting-started-adv.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -233,28 +233,6 @@ node ./bin/run-multiple-apps @app/ex02back @app/ex02front @app/ex03sockeio
233233

234234
Every app should have `multi-app-support.js` file. Check `ex02back`, `ex02front` and `ex02sockio` examples.
235235

236-
## linter
237-
238-
We use [eslint](https://eslint.org) as our linter. It enforces code-style and best-practices
239-
240-
We don't allow bad code into the repo. To ensure this we run [eslint](https://eslint.org) on `CI`.
241-
242-
The configuration for the [eslint](https://eslint.org) is found under `package.json`
243-
244-
**Available CLI-commands:**
245-
246-
- `yarn lint` lint whole project <- this command runs on CI
247-
- `yarn run eslint <directory>` check files in `<directory>`
248-
- `yarn run eslint --fix <directory>` check files in `<directory>` and fix them if possible
249-
250-
**Editor integrations:**
251-
252-
[Webstorm integration:](https://plugins.jetbrains.com/plugin/7494-eslint)
253-
254-
[VSCode integration:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
255-
256-
[Other editors](https://eslint.org/docs/user-guide/integrations#editors)
257-
258236
## Tips
259237

260238
### yarn add

0 commit comments

Comments
 (0)