From 946b25e16728c5e37949dd3214991f769472b998 Mon Sep 17 00:00:00 2001 From: Stefano Baccianella <4247706+mangiucugna@users.noreply.github.com> Date: Sun, 28 Jan 2024 07:48:37 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39e4a3d..26de1b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,12 @@ Make sure to work in a branch to make it easier to create a new PR. **Important: Update the unit tests each time!** In fact I'd go out on a limb and say that you should use TDD for this project. -## Step 3. Open a PR to review +## Step 3. Run pre-commit +Make sure to have pre-commit installed as git hook for this repository and use a virtualenviroment. +This will run all the necessary tests and linters. Saving lots of time to the reviewers + +## Step 4. Open a PR to review Refer the Issue number in your PR -## Step 4. Approval +## Step 5. Approval Profit!