From 60535184631b984f1065ea8f1e419ea43dab93cb Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Fri, 7 Dec 2018 17:24:31 -0800 Subject: [PATCH] Update contributing guide --- .gitignore | 3 ++- dev-requirements.txt | 2 ++ docs/development/getting-started.rst | 8 ++++---- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 608bf483..126d348b 100644 --- a/.gitignore +++ b/.gitignore @@ -6,9 +6,10 @@ .cache/ .coverage .idea +.venv __pycache__/ _build/ build/ dist/ -htmlcov/ \ No newline at end of file +htmlcov/ diff --git a/dev-requirements.txt b/dev-requirements.txt index dd93cc2b..e4cc4987 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,4 +1,6 @@ # Install our development requirements +pretend +pytest tox # Install packaging itself diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst index 7e6b45de..aa47fe68 100644 --- a/docs/development/getting-started.rst +++ b/docs/development/getting-started.rst @@ -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. @@ -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 @@ -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 \ No newline at end of file +.. _`reStructured Text`: http://sphinx-doc.org/rest.html