From b115be2fe0f2721cb96a357cc4c01884a244d47e Mon Sep 17 00:00:00 2001
From: Tomas Beuzen <tomas.beuzen@gmail.com>
Date: Thu, 1 Oct 2020 14:20:55 -0700
Subject: [PATCH] update contributing docs with testing

---
 CONTRIBUTING.md  | 34 ++++++++++++++++++----------------
 requirements.txt |  3 +++
 2 files changed, 21 insertions(+), 16 deletions(-)
 create mode 100644 requirements.txt

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 04706e0..ef1a9eb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -34,25 +34,27 @@ Look through the (https://github.com/executablebooks/cookiecutter-jupyter-book/i
 Ready to contribute? Here's how to set up `cookiecutter-jupyter-book` for local development.
 
 1. Fork the `cookiecutter-jupyter-book` repo on GitHub.
-2. Clone your fork locally:
+2. Clone your fork locally and install requirements:
 
-	```
- 	git clone git@github.com:your_name_here/cookiecutter-jupyter-book.git
-	```
+```sh
+git clone git@github.com:your_name_here/cookiecutter-jupyter-book.git
+pip install -r requirements.txt
+```
 
-4. Create a branch for local development:
+3. Create a branch for local development:
 
-	```
-	git checkout -b name-of-your-bugfix-or-feature
-	```
-	Now you can make your changes locally.
+```sh
+git checkout -b name-of-your-bugfix-or-feature
+```
 
-5. Commit your changes and push your branch to GitHub:
+4. Make your desired changes, run tests, and push your branch to GitHub when you're ready:
 
-	```
-	git add .
-	git commit -m "Your detailed description of your changes."
-	git push origin name-of-your-bugfix-or-feature
-	```
+```sh
+pytest
+black ./ --check
+git add .
+git commit -m "Your detailed description of your changes."
+git push origin name-of-your-bugfix-or-feature
+```
 
-6. Open a pull request through the GitHub website. Naming convention for pull requests is [detailed here](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#commit-messages). For example, a pull request that adds a new feature might be titled: `✨ NEW: validate entered github username`.
\ No newline at end of file
+5. Open a pull request through the GitHub website. Naming convention for pull requests is [detailed here](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#commit-messages). For example, a pull request that adds a new feature might be titled: `✨ NEW: validate entered github username`.
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..2256d45
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+cookiecutter
+pytest
+black
\ No newline at end of file