From 8ab98afc93fb4eb349b0fd3d4a37d9d6bcd2f583 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Fleschenberg?= Date: Wed, 18 Oct 2017 15:28:41 +0200 Subject: [PATCH] Add some basic development docs --- CONTRIBUTING.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..b2937334 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,18 @@ +Contributing to pipenv +====================== + +To work on pipenv itself, fork the repository and clone your fork to your local +system. + +Now, install the development requirements:: + + cd pipenv + virtualenv ~/pipenv-venv # You can use a different path if you like. + source ~/pipenv-venv/bin/activate + python setup.py develop + pipenv install --dev + + +To run the test suite locally:: + + pipenv run pytest tests