added pre-commit install instructions

Author: craigbarratt

README.md

@@ -818,9 +818,10 @@ changes will be lost, since reloading a script file recreates a new global conte
 
 ## Contributing
 
-Contributions are welcome! You are encouraged to submit PRs, bug reports, feature requests or
-add to the Wiki with examples and tutorials. It would be fun to hear about unique and clever
-applications you develop.
+Contributions are welcome! You are encouraged to submit PRs, bug reports, feature requests or add to
+the Wiki with examples and tutorials. It would be fun to hear about unique and clever applications
+you develop. Please see this [README](https://github.com/custom-components/pyscript/tree/master/tests)
+for setting up a development environment and running tests.
 
 ## Useful Links
 

requirements_test.txt

@@ -1,4 +1,5 @@
-croniter==0.3.34
+croniter>=0.3.34
+pre-commit
 pytest
-pytest-cov==2.9.0
+pytest-cov>=2.9.0
 pytest-homeassistant

tests/README.md

@@ -1,22 +1,47 @@
-# Pyscript tests
+# Pyscript Development Setup
 
-For running the tests, you should setup a python virtualenv in the project root directory:
+These setup commands only need to be executed once.  First, clone the repository:
 ```bash
-python3 -m venv venv
+git clone https://github.com/custom-components/pyscript.git
+cd pyscript
+```
+
+Next, create a virtual environment (make sure `python` is version `3.x`; otherwise use `python3`):
+```bash
+python -m venv venv
 source venv/bin/activate
 ```
 
-Install needed dependencies:
+Finally, install the requirements and the pre-commit hooks:
 ```bash
-python3 -m pip install -r requirements_test.txt
+python -m pip install -r requirements_test.txt
+pre-commit install
+```
+
+To develop code and submit PRs you will want to fork the repository, and follow the
+steps above on your forked repository. Once you have pushed your changes to the fork,
+you can go ahead and submit a PR.
+
+# Pyscript Tests
+
+This directory contains various tests for pyscript.
+
+After completing the above setup steps, you need to activate the virtual environment
+every time you start a new shell:
+```bash
+source venv/bin/activate
 ```
 
 Now you can run the tests using this command:
 ```bash
 pytest
 ```
-
-Always remember to activate the virtualenv before running anything: 
+or run a specific test file with:
 ```bash
-source venv/bin/activate
+pytest tests/test_function.py
+```
+
+You can check coverage and list specific missing lines with:
+```
+pytest --cov=custom_components/pyscript --cov-report term-missing
 ```