add pre-commit instructions to contributing.rst

README.md

@@ -5,7 +5,7 @@
 
 # naturf
 
-#### `naturf` (Neighborhood Adaptive Tissues for Urban Resilience Futures) is an open-source geospatial Python package for calculating urban building parameters to be compiled and input to the Weather Research and Forecasting model (WRF).
+#### Neighborhood Adaptive Tissues for Urban Resilience Futures (`naturf`) is an open-source geospatial Python package that calculates and compiles urban building parameters to be input to the Weather Research and Forecasting model (WRF).
 
 ### Purpose
 `naturf` was created to:
@@ -14,7 +14,7 @@
   - Compile the parameters at sub-kilometer resolutions into binary files,
   - Prepare binary files to be fed into WRF to understand the effect of building morphology on the urban microclimate.
 
-### Install `naturf`
+### Install
 
 ```bash
 pip install naturf
@@ -26,9 +26,9 @@ Run `naturf` using the quickstart tutorial: [`naturf` Quickstarter](https://immm
 
 ### User guide
 
-Our user guide provides in-depth information on the key concepts of `naturf` with useful background information and explanation. See our [User Guide](https://immm-sfa.github.io/naturf/user_guide.html)
+Our [user guide](https://immm-sfa.github.io/naturf/user_guide.html) provides in-depth information on the key concepts of `naturf` with useful background information and explanation.
 
-### Contributing to `naturf`
+### Contributing
 
 Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make `naturf` more robust, you are welcome to contribute! See our [Contribution Guidelines](https://immm-sfa.github.io/naturf/contributing.html)
 

docs/source/contributing.rst

@@ -21,12 +21,19 @@ The following is the recommended workflow for contributing to **naturf**:
 
     git clone https://github.com/<your-user-name>/naturf
 
-  Cloning the repository will give you access to the test suite.  It is important to install the package in development mode before running tests.  This will give you the flexibility to make changes in the code without having to rebuild your package before running tests.  To do this run the following from your terminal in the **naturf** directory containing your ``setup.py`` script:
+  Cloning the repository will give you access to the test suite.  It is important to install the package in development mode before running tests.  This will give you the flexibility to make changes in the code without having to rebuild your package before running tests. :
 
   .. code-block:: bash
 
-      python setup.py develop
+      cd naturf
 
+      pip install -e .
+
+  `Install \`pre-commit\` <https://pre-commit.com/>`_, then install the hooks within the repo to auto format code:
+
+  .. code-block:: bash
+
+      pre-commit install
 
 2. Create a branch for your changes