diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000000000000000000000000000000000000..7b8155e8d7a2a9ceda60853393fb43e136ccd893 --- /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.