From 8f96b64213e6a5183cd8368d343cd553c3244c81 Mon Sep 17 00:00:00 2001
From: Bo-Chun Louis Chen <louistw@uab.edu>
Date: Tue, 10 May 2022 17:03:52 -0500
Subject: [PATCH] Update README for pre commit hook
---
.pre-commit-config.yaml | 4 ++++
README.md | 22 ++++++++++++++++++++++
2 files changed, 26 insertions(+)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 7310e57..bcf55a7 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -12,3 +12,7 @@ repos:
rev: 3.9.1
hooks:
- id: flake8
+ - repo: https://github.com/PyCQA/pylint
+ rev: v2.13.8
+ hooks:
+ - id: pylint
diff --git a/README.md b/README.md
index 1a67073..72f1361 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,28 @@ $ pip install -r requirements.txt
`$ rabbitmqctl change_password reggie <new_password>`.
- Note that rabbitmqctl may require sudo permissions and that changing the password will require a password
change in the credentials within `test_producer.py` and `base_consumer.py` as well.
+
+
+### Setup pre commit hook
+
+- via Homebrew(Mac)
+
+```shell
+brew install pre-commit
+```
+
+- via pip
+
+```shell
+pip install pre-commit
+```
+
+After pre-commit is installed, run install in the repo directory:
+```shell
+$ pre-commit install
+> pre-commit installed at .git/hooks/pre-commit
+```
+
# Run Project
## 1. Connect to OHPC/OOD
--
GitLab