centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

contributing.md: fix typos, add link (#1774)

Browse Source
This commit is contained in:
Heini Fagerlund
2019-03-25 17:43:44 -04:00
committed by Waylan Limberg
parent d101522aa1
commit eb5f3f84e5
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/about/contributing.md
View File

@@ -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/