Skip to content

Commit fff5b20

Browse files
authored
Merge pull request #6 from matplotlib/doc_fix_contributing
DOC: tweak contributing.rst
2 parents 5be9b47 + 22b0efa commit fff5b20

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

CONTRIBUTING.rst

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,33 +61,41 @@ Ready to contribute? Here's how to set up `mpl-gui` for local development.
6161

6262
$ git clone [email protected]:your_name_here/mpl-gui.git
6363

64-
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
64+
3. Install your local copy into a virtualenv. Using the standard-libary `venv`, see
65+
[the Python documentation](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) for details ::
66+
67+
$ python -m venv mpl-gui-dev
68+
$ source mpl-gui-dev/activate # unix
69+
$ mpl-gui-dev\Scripts\activate.bat # windows
70+
71+
or other virtual environment tool (e.g. conda, canopy) of choice.
72+
73+
4. Install the development dependencies ::
6574

66-
$ mkvirtualenv mpl-gui
6775
$ cd mpl-gui/
68-
$ python setup.py develop
76+
$ pip install -r requirements-dev.txt
77+
$ pip install -v --no-build-isolation .
6978

70-
4. Create a branch for local development::
79+
5. Create a branch for local development::
7180

7281
$ git checkout -b name-of-your-bugfix-or-feature
7382

7483
Now you can make your changes locally.
7584

76-
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
85+
6. When you're done making changes, check that your changes pass flake8 and the tests::
7786

7887
$ flake8 mpl_gui tests
79-
$ python setup.py test
80-
$ tox
88+
$ pytest
8189

82-
To get flake8 and tox, just pip install them into your virtualenv.
90+
To get flake8 and pytest, pip install them into your virtualenv.
8391

84-
6. Commit your changes and push your branch to GitHub::
92+
7. Commit your changes and push your branch to GitHub::
8593

8694
$ git add .
8795
$ git commit -m "Your detailed description of your changes."
8896
$ git push origin name-of-your-bugfix-or-feature
8997

90-
7. Submit a pull request through the GitHub website.
98+
8. Submit a pull request through the GitHub website.
9199

92100
Pull Request Guidelines
93101
-----------------------
@@ -98,7 +106,4 @@ Before you submit a pull request, check that it meets these guidelines:
98106
2. If the pull request adds functionality, the docs should be updated. Put
99107
your new functionality into a function with a docstring, and add the
100108
feature to the list in README.rst.
101-
3. The pull request should work for Python 2.7, 3.3, 3.4, 3.5 and for PyPy. Check
102-
https://travis-ci.org/tacaswell/mpl-gui/pull_requests
103-
and make sure that the tests pass for all supported Python versions.
104-
109+
3. The pull request should work for Python 3.7 and up.

0 commit comments

Comments
 (0)