[DOC] Add hint for contributors to install the package in editable mo…

…de for the CLI to incorporate changes in code basis (#81)
PabloRMira · Dec 21, 2020 · 95c5d42 · 95c5d42
1 parent 0ad891d
commit 95c5d42
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -359,6 +359,7 @@
     "2. Install our conda development environment running `conda env create -f environment.yml`\n",
     "3. Activate the python environment using `conda activate sql-formatter-dev`\n",
     "4. Run `nbdev_install_git_hooks`\n",
+    "5. Run `pip install -e .` to install the package in editable mode. This way the command line interface (CLI) `sql-formatter` will incorporate your changes in the python code\n",
     "\n",
     "#### Development Workflow\n",
     "\n",