aboutsummaryrefslogtreecommitdiffstats
path: root/docs/coding_conventions_python.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-01-13 21:27:12 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-01-14 07:52:14 -0800
commit58d27cf404b2a7e02f4adf17eaba9163aac3abf7 (patch)
tree5941f95bbf5098b0afe8c0206e2f56b6f5b4db17 /docs/coding_conventions_python.md
parent44168baaa74190bb78216c27500101a75516fad6 (diff)
downloadfirmware-58d27cf404b2a7e02f4adf17eaba9163aac3abf7.tar.gz
firmware-58d27cf404b2a7e02f4adf17eaba9163aac3abf7.tar.bz2
firmware-58d27cf404b2a7e02f4adf17eaba9163aac3abf7.zip
Add a note explaining how to run tests
Diffstat (limited to 'docs/coding_conventions_python.md')
-rw-r--r--docs/coding_conventions_python.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/coding_conventions_python.md b/docs/coding_conventions_python.md
index cf9ab838e..1aefc044e 100644
--- a/docs/coding_conventions_python.md
+++ b/docs/coding_conventions_python.md
@@ -311,7 +311,7 @@ FIXME(username): Revisit this code when the frob feature is done.
# Testing
-We use a combination of Integration and Unit testing to ensure that the our code is as bug-free as possible. All the tests can be found in `lib/python/qmk/tests/`.
+We use a combination of Integration and Unit testing to ensure that the our code is as bug-free as possible. All the tests can be found in `lib/python/qmk/tests/`. You can run all the tests with `qmk pytest`.
At the time of this writing our tests are not very comprehensive. Looking at the current tests and writing new test cases for untested situations is a great way to both familiarize yourself with the codebase and contribute to QMK.