summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2023-03-21 13:48:30 -0400
committerNed Batchelder <ned@nedbatchelder.com>2023-03-21 13:48:30 -0400
commit551522eb214ad0c3f1dc48cd112a4f0ba6ddc6b6 (patch)
treee76d0a2787efda84f594db9e2160b00b870b63f5
parent00d2ecf893fef59d17bfd434ef7e2d5e2fd50818 (diff)
downloadpython-coveragepy-git-551522eb214ad0c3f1dc48cd112a4f0ba6ddc6b6.tar.gz
docs: fix some formatting in contributing.rst
-rw-r--r--doc/contributing.rst13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst
index 7cba0859..fa7bb9f0 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -37,15 +37,13 @@ The coverage.py code is hosted on a GitHub repository at
https://github.com/nedbat/coveragepy. To get a working environment, follow
these steps:
-#. `Fork the repo`__ into your own GitHub account. The coverage.py code
-will then be copied into a GitHub repository at
-https://github.com/GITHUB_USER/coveragepy where GITHUB_USER is your GitHub
-username.
-
-__ https://docs.github.com/en/get-started/quickstart/fork-a-repo
+#. `Fork the repo`_ into your own GitHub account. The coverage.py code will
+ then be copied into a GitHub repository at
+ ``https://github.com/GITHUB_USER/coveragepy`` where GITHUB_USER is your
+ GitHub username.
#. (Optional) Create a virtualenv to work in, and activate it. There
-are a number of ways to do this. Use the method you are comfortable with.
+ are a number of ways to do this. Use the method you are comfortable with.
#. Clone the repository::
@@ -253,6 +251,7 @@ All contributions are expected to include tests for new functionality and
fixes. If you need help writing tests, please ask.
+.. _fork the repo: https://docs.github.com/en/get-started/quickstart/fork-a-repo
.. _editorconfig.org: http://editorconfig.org
.. _tox: https://tox.readthedocs.io/
.. _black: https://pypi.org/project/black/