Updated CI info in contributing docs (#4415)

* updated CI info in contributing docs

* Split CI checks into two sections

* Reorder CI sections

* Renamed CI sections

---------

Co-authored-by: pngwn <hello@pngwn.io>
Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com>
This commit is contained in:
2-5 2023-06-06 12:52:29 +00:00 committed by GitHub
parent 8730d40505
commit 0a8dbcafa2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 3 deletions

View File

@ -91,10 +91,26 @@ bash scripts/format_backend.sh
bash scripts/format_frontend.sh
```
You can run the circleci checks locally as well.
## CI checks
Currently the following checks are run in CI:
### Gradio library (`gradio` package)
```
bash scripts/run_circleci.sh
bash scripts/lint_backend.sh
bash scripts/type_check_backend.sh
python -m pytest -m "not flaky" --ignore=client
python -m pytest -m "flaky" --ignore=client
```
### Gradio client (`gradio_client` package)
```
cd client/python
bash scripts/lint.sh
python -m pytest -m "not flaky"
python -m pytest -m "flaky"
```
_Could these guidelines be clearer? Feel free to open a PR to help us faciltiate open-source contributions!_

View File

@ -90,6 +90,19 @@ pnpm ts:check
Currently the following checks are run in CI:
### static checks
- Format check (`pnpm format:check`)
- Build css (`pnpm css`)
- Build client (`pnpm build`)
- Type check (`pnpm ts:check`)
- Build as a smoke test (`pnpm build`)
- Unit tests (`pnpm test:run`)
### functional test
```
pip install -r demo/outbreak_forecast/requirements.txt
pnpm exec playwright install chromium
pnpm exec playwright install-deps chromium
pnpm test:browser:full
```