File tree Expand file tree Collapse file tree 4 files changed +54
-13
lines changed
Expand file tree Collapse file tree 4 files changed +54
-13
lines changed Original file line number Diff line number Diff line change 1+ Contributing
2+ ============
3+
4+ If you want to improve the code base, add a feature or update the
5+ documentation please open a `pull request `_. Feel free to `open an issue `_
6+ beforehand to discuss your plans.
7+
8+ .. _pull request : https://github.com/painless-software/python-cli-test-helpers/pulls
9+ .. _open an issue : https://github.com/painless-software/python-cli-test-helpers/issues
10+
11+ Development
12+ -----------
13+
14+ This project uses Tox to run its test suite. Install it using Pip like this:
15+
16+ .. code-block :: shell
17+
18+ python3 -m pip install tox
19+
20+ Alternatively, if you use `uv `_, install Tox as a development tool like this:
21+
22+ .. code-block :: shell
23+
24+ uv tool install tox --with tox-uv
25+
26+ Usage:
27+
28+ .. code-block :: shell
29+
30+ tox list # list available environments
31+ tox -e py # run tests with local default Python
32+ tox -e lint,format # run a few environments
33+ tox # run entire suite
34+
35+ .. _uv : https://docs.astral.sh/uv/
36+
37+ Documentation
38+ -------------
39+
40+ Build the documentation locally and view it in your Web browser:
41+
42+ .. code-block :: console
43+
44+ $ tox -e clean,docs
45+ ...
46+ $ cd docs/_build/html/
47+ $ python -m http.server
48+ Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
49+
50+ Click on the displayed link to inspect the generated documentation.
Original file line number Diff line number Diff line change @@ -42,6 +42,7 @@ arguments and environment variable values.
4242.. _docopt : http://docopt.org/
4343.. _documentation : https://python-cli-test-helpers.readthedocs.io/
4444.. _CLI Copier template : https://gitlab.com/painless-software/cicd/app/cli
45+ .. _CONTRIBUTING : https://github.com/painless-software/python-cli-test-helpers/blob/main/CONTRIBUTING.rst
4546
4647.. links-marker
4748
@@ -61,16 +62,4 @@ effortlessly.
6162Development
6263-----------
6364
64- This project uses Tox to run its test suite. Install and use it locally like
65- this:
66-
67- .. code-block :: shell
68-
69- python3 -m pip install tox
70-
71- .. code-block :: shell
72-
73- tox list # list available environments
74- tox -e lint,py312 # run a few environments
75- tox -e py # run tests with local default Python
76- tox # run entire suite
65+ See `CONTRIBUTING `_.
Original file line number Diff line number Diff line change 1+ .. include :: ../CONTRIBUTING.rst
Original file line number Diff line number Diff line change @@ -11,6 +11,7 @@ Contents
1111 tutorial
1212 other
1313 techniques
14+ contributing
1415
1516Quotes
1617------
You can’t perform that action at this time.
0 commit comments