From 520d4cb25d7bf59e783756f520598a545d2cae8f Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Mon, 20 Nov 2023 16:39:22 -0700 Subject: [PATCH] Developer docs begin - precommit --- Developers.md | 21 +++++++++++++++++++++ requirements.txt | 4 +++- 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 Developers.md diff --git a/Developers.md b/Developers.md new file mode 100644 index 00000000..ca7fda93 --- /dev/null +++ b/Developers.md @@ -0,0 +1,21 @@ +Developers + +Install pre-commit (https://pre-commit.com/) + +```bash +pip install pre-commit +``` + +Check that it's installed + +```bash +pre-commit --versioni +``` + +This repository already has a pre-commit configuration. To install the hooks, run: + +```bash +pre-commit install +``` + +Now when you make a git commit, the black code formatter and ruff linter will run. diff --git a/requirements.txt b/requirements.txt index b6a1d69a..2330d399 100644 --- a/requirements.txt +++ b/requirements.txt @@ -73,4 +73,6 @@ rich mkdocs mkdocs-material -mkdocs-glightbox \ No newline at end of file +mkdocs-glightbox + +pre-commit