From 8d4c3d97ec7cdef0c9700bd250fca5f27a36bf81 Mon Sep 17 00:00:00 2001 From: Grant Timmerman <744973+grant@users.noreply.github.com> Date: Fri, 10 Jun 2022 10:09:00 -0700 Subject: [PATCH] docs: add local testing docs Signed-off-by: Grant Timmerman <744973+grant@users.noreply.github.com> --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 939e5341..73aef19e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,23 @@ use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests. +### Testing + +You can locally test using [`tox`](https://tox.wiki/). + +Unit tests: + +``` +python -m tox -e py38-ubuntu-latest +python -m tox -e lint +``` + +Lint: + +``` +.tox/lint/bin/black tests +``` + ## Community Guidelines This project follows [Google's Open Source Community