From 717ba152ac5874e07eac5fe78843551a176530fb Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Mon, 13 May 2024 17:01:55 -0500 Subject: [PATCH] Document and polish --- .gitignore | 1 + CONTRIBUTING.rst | 11 +++++++++++ tox.ini | 1 - 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 4907abba..1ceffeb1 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ __pycache__/ src/__pycache__/ duct.egg-info/ .coverage +coverage.* .duct/ .idea .tox/ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 620a395b..89509b9f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -19,3 +19,14 @@ The following pull request labels are respected: * tests: Add or improve existing tests * dependencies: Update one or more dependencies version * performance: Improve performance of an existing feature + + +Testing +------- +If you are contributing code, please consider adding a unit test. + +To run the tests: +`tox` + +To run tests on one file (args after -- are passed to pytest): +`tox -- test/test_my_thing.py` diff --git a/tox.ini b/tox.ini index afb71aab..d2d7530c 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,5 @@ [tox] envlist = lint,typing,py38,py39,py310,py311,py312,pypy3 -# envlist = lint,py37,py38,py39,py310,py311,py312,pypy3 skip_missing_interpreters = True isolated_build = True minversion = 3.3.0