* Fix docs

* Add short section about testing to contribution guide

* Add back note for voice configuration

* Remove LICENSE symlink from docs/

* Fix site_url in mkdocs.yml
This commit is contained in:
Reinier van der Leer
2023-04-26 20:14:14 +02:00
committed by GitHub
parent 109fa04c7c
commit 76df14b831
14 changed files with 522 additions and 381 deletions

View File

@@ -1,39 +1,46 @@
## Run tests
# Running tests
To run all tests, run the following command:
To run all tests, use the following command:
```
pytest
``` shell
pytest
```
To run just without integration tests:
```
pytest --without-integration
If `pytest` is not found:
``` shell
python -m pytest
```
To run just without slow integration tests:
### Running specific test suites
```
pytest --without-slow-integration
- To run without integration tests:
:::shell
pytest --without-integration
- To run without *slow* integration tests:
:::shell
pytest --without-slow-integration
- To run tests and see coverage:
:::shell
pytest --cov=autogpt --without-integration --without-slow-integration
## Runing the linter
This project uses [flake8](https://flake8.pycqa.org/en/latest/) for linting.
We currently use the following rules: `E303,W293,W291,W292,E305,E231,E302`.
See the [flake8 rules](https://www.flake8rules.com/) for more information.
To run the linter:
``` shell
flake8 .
```
To run tests and see coverage, run the following command:
Or:
``` shell
python -m flake8 .
```
pytest --cov=autogpt --without-integration --without-slow-integration
```
## Run linter
This project uses [flake8](https://flake8.pycqa.org/en/latest/) for linting. We currently use the following rules: `E303,W293,W291,W292,E305,E231,E302`. See the [flake8 rules](https://www.flake8rules.com/) for more information.
To run the linter, run the following command:
```
flake8 autogpt/ tests/
# Or, if you want to run flake8 with the same configuration as the CI:
flake8 autogpt/ tests/ --select E303,W293,W291,W292,E305,E231,E302
```