From b5f2855d49438d7b6da67df77b5336d19a1689ae Mon Sep 17 00:00:00 2001
From: Rane Brown <rane.brown@gmail.com>
Date: Sat, 23 Mar 2024 15:08:03 -0600
Subject: [PATCH] docs: include setup and formatting steps

---
 CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a33af04..2cdb81e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,5 @@
+# Contributing
+
 Contributions welcome. Preferably:
 - include a test file. I realize this is sometimes a pain to create, but there is no way
   for me to test external contributions without test files
@@ -18,3 +20,30 @@ Contributions welcome. Preferably:
                ├── History_for_Account_X8YYYYYYY.csv
                └── run_test.bash
   ```
+
+## Setup
+
+Development setup would typically look something like this:
+
+```bash
+# clone repo, cd to repo
+
+# create virtual environment
+python3 -m venv venv
+
+# activate virtual environment
+source venv/bin/activate
+
+# install dependencies
+pip install -e .[dev]
+```
+
+## Formatting
+
+Prior to finalizing a pull request make sure to run the formatting tools and
+commit any resulting changes.
+
+```bash
+ruff format
+isort --profile black .
+```