Skip to content

DOC: tweak contributing.rst #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2022
Merged

DOC: tweak contributing.rst #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29ccdf6
DOC: tweak contributing.rst
tacaswell Feb 11, 2022
22b0efa
DOC: fix numbering
tacaswell Apr 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 19 additions & 14 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,33 +61,41 @@ Ready to contribute? Here's how to set up `mpl-gui` for local development.

$ git clone git@github.com:your_name_here/mpl-gui.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
3. Install your local copy into a virtualenv. Using the standard-libary `venv`, see
[the Python documentation](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) for details ::

$ python -m venv mpl-gui-dev
$ source mpl-gui-dev/activate # unix
$ mpl-gui-dev\Scripts\activate.bat # windows

or other virtual environment tool (e.g. conda, canopy) of choice.

4. Install the development dependencies ::

$ mkvirtualenv mpl-gui
$ cd mpl-gui/
$ python setup.py develop
$ pip install -r requirements-dev.txt
$ pip install -v --no-build-isolation .

4. Create a branch for local development::
5. Create a branch for local development::

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

Now you can make your changes locally.

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

$ flake8 mpl_gui tests
$ python setup.py test
$ tox
$ pytest

To get flake8 and tox, just pip install them into your virtualenv.
To get flake8 and pytest, pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::
7. Commit your changes and push your branch to GitHub::

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

7. Submit a pull request through the GitHub website.
8. Submit a pull request through the GitHub website.

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

3. The pull request should work for Python 3.7 and up.