Skip to content

Commit 1469085

Browse files
committed
docs: further slimming down of contribution instructions
1 parent 14beae2 commit 1469085

File tree

1 file changed

+12
-27
lines changed

1 file changed

+12
-27
lines changed

doc/contributing.rst

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,19 @@ you frustration.
3333
Getting the code
3434
----------------
3535

36-
Fork the repo into your own github repository. If you have not forked a
37-
repository before then please follow the `fork instructions`_ provided by
38-
github.
36+
The coverage.py code is hosted on a GitHub repository at
37+
https://github.com/nedbat/coveragepy. To get a working environment, follow
38+
these steps:
3939

40-
.. _fork instructions: https://docs.github.com/en/get-started/quickstart/fork-a-repo
40+
#. `Fork the repo`__ into your own GitHub account. The coverage.py code
41+
will then be copied into a GitHub repository at
42+
https://github.com/GITHUB_USER/coveragepy where GITHUB_USER is your GitHub
43+
username.
4144

42-
The coverage.py code will then be copied into a GitHub repository at
43-
https://github.com/GITHUB_USER/coveragepy where GITHUB_USER is your github
44-
username. To get a working development environment, follow these steps:
45-
46-
.. minimum of PYVERSIONS:
47-
48-
#. Create a virtualenv using one of the common virtualenv formats (conda,
49-
venv, pipenv, etc) and a version of python greater than 3.7 to work in, and
50-
activate it. Please follow your virtualenv format specific creation and
51-
activation instructions.
45+
__ https://docs.github.com/en/get-started/quickstart/fork-a-repo
5246

47+
#. (Optional) Create a virtualenv to work in, and activate it. There
48+
are a number of ways to do this. Use the method you are comfortable with.
5349

5450
#. Clone the repository::
5551

@@ -58,27 +54,16 @@ activation instructions.
5854

5955
#. Install the requirements::
6056

61-
$ python3 -m pip install -r requirements/dev.pip
62-
63-
If this fails due to incorrect or missing hashes, use
64-
``dev.in`` instead::
65-
6657
$ python3 -m pip install -r requirements/dev.in
67-
68-
Note: You may need to upgrade pip to install the requirements.
6958

70-
#. (Optional) Install more versions of Python. By default, Coverage.py won't
71-
run the tests on a version of python that isn't installed. Coverage.py
72-
supports a range of Python versions. The more you can test with, the more
73-
easily your code can be used as-is. If you only have one version, that's
74-
OK too, but may mean more work integrating your contribution.
59+
Note: You may need to upgrade pip to install the requirements.
7560

7661

7762
Running the tests
7863
-----------------
7964

8065
The tests are written mostly as standard unittest-style tests, and are run with
81-
pytest running under `tox`_ by using the command `python3 -m tox`::
66+
pytest running under `tox`_::
8267

8368
% python3 -m tox
8469
ROOT: tox-gh won't override envlist because tox is not running in GitHub Actions

0 commit comments

Comments
 (0)