Update information about the tox command setup

Added more information about how the tox pipeline works
and an external link to the tox documentation.
Added outputs relevant to the successful execution of
the tox command.
Signed-off-by: Adithya Venkateswaran's avatarAdithya Venkateswaran <[email protected]>
parent e3447299
Pipeline #127927851 passed with stages
in 7 minutes and 15 seconds
......@@ -116,14 +116,34 @@ $ source .venv/bin/activate
$ (.venv) pip install -e .
```
Format the code before commiting, otherwise the CI engine will fail:
It is important to format the code before commiting, otherwise the
CI engine will fail. We have a tox command setup to run tests before
committing so you will never have to push failing pipelines. Code
linting is also done to ensure the code does not have any errors
before committing:
```bash
# Install tox to execute CI tasks
$ (.venv) pip install tox
# Auto-format the code
$ (.venv) tox -e yapf-apply -e isort-apply
______________________ summary______________________
yapf-apply: commands succeeded
isort: commands succeeded
congratulations :)
# Verify CI test passes
$ (.venv) tox
# If all goes well, you will get something like this:
______________________ summary______________________
flake8: commands succeeded
isort: commands succeeded
yapf: commands succeeded
pylint: commands succeeded
build: commands succeeded
pytest: commands succeeded
congratulations :)
```
You can learn more about tox [here](https://tox.readthedocs.io/en/latest/).
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