sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add optional selection of specific unit test to Makefile

Browse Source
This commit is contained in:
xs5871
2023-02-16 09:21:13 +00:00
committed by xs5871
parent 61cf527370
commit 08c255b6e4
2 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/contributing.md
View File

@@ -27,7 +27,12 @@ to Black formatting as documented in `pyproject.toml`)
Unit tests within the `tests` folder mock various CircuitPython modules to allow
them to be executed in a desktop development environment.
Execute tests using the command `python -m unittest`.
Execute tests using the command `make unit-tests`. The unit-tests target accepts
an optional environment variable for specifying a subset of tests with python
unittest syntax:
```sh
make unit-tests TESTS="tests.test_capsword tests.test_hold_tap"
```
## Contributing Documentation
While KMK welcomes documentation from anyone with and understanding of the issues