From 58d27cf404b2a7e02f4adf17eaba9163aac3abf7 Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 13 Jan 2020 21:27:12 -0800 Subject: [PATCH] Add a note explaining how to run tests --- docs/coding_conventions_python.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/coding_conventions_python.md b/docs/coding_conventions_python.md index cf9ab838ed..1aefc044e8 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.