Merge pull request #221 from NREL/ndr/update-docs

Update docs

README.md

@@ -13,9 +13,6 @@
   </a>
 </div>
 
-
-
-
 RouteE Compass is an energy-aware routing engine for the RouteE ecosystem of software tools with the following key features:
 
 - Dynamic and extensible search objectives that allow customized blends of distance, time, cost, and energy (via RouteE Powertrain) at query-time
@@ -36,6 +33,8 @@ See the [documentation](https://nrel.github.io/routee-compass/) for more informa
 
 RouteE Compass is currently maintained by Nick Reinicke ([@nreinicke](https://github.com/nreinicke)) and Rob Fitzgerald ([@robfitzgerald](https://github.com/robfitzgerald)).
 
+If you're interested in contributing, please checkout the [contributing](https://nrel.github.io/routee-compass/developers/contributing.html) guide.
+
 ## License
 
 Copyright 2023 Alliance for Sustainable Energy, LLC

docs/developers/contributing.md

@@ -24,6 +24,7 @@ This simple guide will walk you through the process of contributing to RouteE Co
 
 1. Create and activate a new virtual environment with the tool of your choice (e.g. venv, conda, pipenv, etc.).
 1. Install the package and dependencies by running pip install -e ".[dev]". This will install the package in editable mode, so you can make changes to the code and see them reflected in your environment.
+1. Make sure everything is working by running the tests with pytest. `pytest python/tests`
 
 ## Opening a Pull Request