Add initial DEVELOPMENT guidelines

aiven · Feb 18, 2020 · cc2148e · cc2148e
1 parent 7b9d11b
commit cc2148e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+.idea/
+.venv/
+Pipfile*
 /.cache/
 *.pyc
 *~

diff --git a/DEVELOPMENT.rst b/DEVELOPMENT.rst
@@ -0,0 +1,14 @@
+Development
+===========
+
+To install all dependencies locally with ``pipenv``, run:
+
+::
+
+    pipenv install --three -e .
+
+After the local virtual environment is created, run the following to "shell in" so that you can start making changes:
+
+::
+
+    pipenv shell