Skip to content

Commit f2571ea

Browse files
committed
Simplify contributing guide
1 parent ff7f9de commit f2571ea

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,23 @@ You can (and should) run our test suite using [*tox*].
4343
However, you’ll probably want a more traditional environment as well.
4444
We highly recommend to develop using the latest Python release because we try to take advantage of modern features whenever possible.
4545

46-
First create a [virtual environment](https://virtualenv.pypa.io/) so you don't break your system-wide Python installation.
47-
It’s out of scope for this document to list all the ways to manage virtual environments in Python, but if you don’t already have a pet way, take some time to look at tools like [*direnv*](https://hynek.me/til/python-project-local-venvs/), [*virtualfish*](https://virtualfish.readthedocs.io/), and [*virtualenvwrapper*](https://virtualenvwrapper.readthedocs.io/).
48-
49-
Next, get an up-to-date checkout of the *attrs* repository:
46+
Clone the *attrs* repository to your computer:
5047

5148
```console
5249
$ git clone [email protected]:python-attrs/attrs.git
5350
```
5451

55-
or if you prefer to use *Git* via `https`:
52+
Or if you prefer to use Git via HTTPS:
5653

5754
```console
5855
$ git clone https://github.com/python-attrs/attrs.git
5956
```
6057

61-
Change into the newly created directory and **after activating your virtual environment** install an editable version of *attrs* along with its tests and docs requirements:
58+
Change into the newly created directory and after activating a virtual environment install an editable version of *attrs* along with its tests and docs requirements:
6259

6360
```console
6461
$ cd attrs
65-
$ python -m pip install --upgrade pip wheel setuptools # PLEASE don't skip this step
62+
$ python -m pip install --upgrade pip wheel # PLEASE don't skip this step
6663
$ python -m pip install -e '.[dev]'
6764
```
6865

0 commit comments

Comments
 (0)