paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 38 Packages Projects Releases Wiki Activity

docs(techdocs-core): added linting section

Browse Source
This commit is contained in:
Bilawal Hameed
2020-06-23 20:45:22 +02:00
parent d6cf8892fe
commit f9ee9991a0
1 changed files with 3 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs/mkdocs/container/techdocs-core/README.md
+3 -6
View File
@@ -35,14 +35,11 @@ In the parent `Dockerfile` we add this folder to the build and install the packa
See the `README.md` located in the `mkdocs/` folder for more details on how to build and run the Docker container.
## Linting and Tests
To run the tests, you'll need `tox` installed with our dependencies installed:
## Linting
```bash
pip install tox
pip install -r requirements.txt
tox
python -m black src/
```
This will invoke our linter and tests. You can configure this by editing the `tox.ini` folder located in this folder.
**Note:** This will write to all Python files in `src/` with the formatted code. If you would like to only check to see if it passes, simply append the `--check` flag.