Unverified Commit 923657df authored by Lijiaoa's avatar Lijiaoa Committed by GitHub
Browse files

[webui] update dev doc (#4513)

parent 59f4c091
...@@ -6,15 +6,14 @@ WebUI is built by using [React](https://reactjs.org/docs/getting-started.html) a ...@@ -6,15 +6,14 @@ WebUI is built by using [React](https://reactjs.org/docs/getting-started.html) a
## Development ## Development
* Please refer the [installation doc](https://github.com/microsoft/nni#installation) to run an experiment. * Please refer the [installation doc](https://github.com/microsoft/nni#installation) to run an experiment.
* WebUI uses [eslint](https://eslint.org/docs/user-guide/getting-started) and [prettier](https://prettier.io/docs/en/index.html) to format code. You could change the eslintrc file like this picture when you are coding.
<img src="../../docs/img/webui-img/rules.png" /> * Use this command in `webui/ts` directory when you change webui code. And then refresh website to see latest pages.
* Use this command in `webui/ts` directory when you want to see latest website.
```bash ```bash
yarn build yarn build
``` ```
## PR ## PR
* If you need to send the PR, you should change the eslintrc file back and use the command `yarn eslint` to check style. And `yarn eslint --fix` could fix almost warnings and errors. Also use `yarn stylelint` to confirm `.scss & .css` style. * WebUI uses [eslint](https://eslint.org/docs/user-guide/getting-started) and [prettier](https://prettier.io/docs/en/index.html) to format code. Before you send PR, you could use the command `yarn sanity-check` to format code style.
\ No newline at end of file
* You could send the PR if `yarn release` gets successful build after formatting code.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment