From eb5f3f84e533cff42e13492af2a5e1ab391865e9 Mon Sep 17 00:00:00 2001 From: Heini Fagerlund Date: Mon, 25 Mar 2019 17:43:44 -0400 Subject: [PATCH] contributing.md: fix typos, add link (#1774) --- docs/about/contributing.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/about/contributing.md b/docs/about/contributing.md index 5d4337ef..aa5aeb4f 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -49,9 +49,11 @@ to the git repository. ## Running the tests -To run the tests, it is recommended that you use [Tox]. This just needs -to be pip installed and then the test suite can be ran for MkDocs but running -the command `tox` in the root of your MkDocs repository. +To run the tests, it is recommended that you use [tox]. + +Install Tox using [pip] by running the command `pip install tox`. +Then the test suite can be run for MkDocs by running the command `tox` in the +root of your MkDocs repository. It will attempt to run the tests against all of the Python versions we support. So don't be concerned if you are missing some and they fail. The rest @@ -64,6 +66,7 @@ it to your fork and send a pull request. For a change to be accepted it will most likely need to have tests and documentation if it is a new feature. [virtualenv]: https://virtualenv.pypa.io/en/latest/userguide.html +[pip]: https://pip.pypa.io/en/stable/ [tox]: https://tox.readthedocs.io/en/latest/ [travis]: https://travis-ci.org/repositories [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/