From dacb718bb4c301d44d10f389ed29573f3501ed23 Mon Sep 17 00:00:00 2001
From: Max Drexler <mndrexler@wisc.edu>
Date: Mon, 8 Jul 2024 16:20:14 +0000
Subject: [PATCH] add CONTRIBUTING

---
 CONTRIBUTING | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 CONTRIBUTING

diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..7b8155e
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,17 @@
+# Contributing
+
+How to set up your dev environment to work on the grib processor.
+
+First, create a virtual environment like in the [readme](/README.md#setup).
+
+Then, install ruff and mypy.
+
+Before pushing commits run:
+
+`ruff format grib_processor.py`
+
+`ruff check grib_processor.py`
+
+`mypy grib_processor.py`
+
+>Note: mypy will give an error about untyped imports, this can be ignored.
-- 
GitLab