Skip to content

Commit

Permalink
Merge pull request #153 from brettcannon/update-contributing-guide
Browse files Browse the repository at this point in the history
Update contributing guide to work on first go
  • Loading branch information
di authored Dec 15, 2018
2 parents d9292d9 + 6053518 commit 7ee419c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
.cache/
.coverage
.idea
.venv

__pycache__/
_build/
build/
dist/
htmlcov/
htmlcov/
2 changes: 2 additions & 0 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Install our development requirements
pretend
pytest
tox

# Install packaging itself
Expand Down
8 changes: 4 additions & 4 deletions docs/development/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ dependencies, install packaging in ``editable`` mode. For example:
.. code-block:: console
$ # Create a virtualenv and activate it
$ pip install --requirement dev-requirements.txt
$ pip install --editable .
$ python -m pip install --requirement dev-requirements.txt
$ python -m pip install --editable .
You are now ready to run the tests and build the documentation.

Expand All @@ -23,7 +23,7 @@ automatically, so all you have to do is:

.. code-block:: console
$ py.test
$ python -m pytest
...
62746 passed in 220.43 seconds
Expand Down Expand Up @@ -73,4 +73,4 @@ The HTML documentation index can now be found at
.. _`virtualenv`: https://pypi.org/project/virtualenv/
.. _`pip`: https://pypi.org/project/pip/
.. _`sphinx`: https://pypi.org/project/Sphinx/
.. _`reStructured Text`: http://sphinx-doc.org/rest.html
.. _`reStructured Text`: http://sphinx-doc.org/rest.html

0 comments on commit 7ee419c

Please sign in to comment.