LBRYCommunity/lbry-desktop
1
0
Fork 0
Code Issues 596 Pull requests 6 Projects Releases 238 Packages Wiki Activity

Update documentation for DevTools and fix some ESLint warnings #911

Merged
IGassmann merged 8 commits from issue/763 into master 2018-01-02 06:41:40 +01:00
Conversation 0 Commits 8 Files changed 42 +17 -7
1 changed files with 17 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 5d2a760b34 - Show all commits

24
CONTRIBUTING.md
View file

@ -60,16 +60,22 @@ our styling rules and code best practices.
### Run ### Run
LBRY app can be run for development by using the command `yarn dev`. This will launch the app and LBRY app can be run for development by using the command:
provide HMR (Hot Module Replacement). Any change made to the sources will automatically reload the
app without losing its state. `yarn dev`
This will launch the app and provide HMR (Hot Module Replacement). Any change made to the sources
will automatically reload the app without losing its state.
### Lint ### Lint
Code linting is ensured by [ESLint](https://eslint.org/). Code linting is ensured by [ESLint](https://eslint.org/).
You can lint all the project's sources at any time by using the `yarn lint` command. If you desire You can lint all the project's sources at any time by running:
to lint a specific file or directory you can use `yarn eslint 'glob/pattern'`.
`yarn lint`
If you desire to lint a specific file or directory you can use `yarn eslint 'glob/pattern'`.
In addition to those commands, staged files are automatically linted before commit. Please take the In addition to those commands, staged files are automatically linted before commit. Please take the
time to fix all staged files' linting problems before committing or suppress them if necessary. time to fix all staged files' linting problems before committing or suppress them if necessary.
@ -83,8 +89,12 @@ Project's sources are formatted using [Prettier](https://prettier.io/).
Staged files are automatically formatted before commit. Staged files are automatically formatted before commit.
You can also use the command `yarn format` for applying formatting rules to all project's code You can also use the following command:
sources. For formatting a specific file or directory use `yarn prettier 'glob/pattern'`.
`yarn format`
for applying formatting rules to all project's code sources. For formatting a specific file or
directory use `yarn prettier 'glob/pattern'`.
Editor integrations are available [here](https://prettier.io/docs/en/editors.html). Editor integrations are available [here](https://prettier.io/docs/en/editors.html).