From 54c1c1498d982fa63c32d311f344451984adf640 Mon Sep 17 00:00:00 2001 From: yoannchb-pro <71560747+yoannchb-pro@users.noreply.github.com> Date: Wed, 28 Feb 2024 16:51:59 -0500 Subject: [PATCH] Update CONTRIBUTE.md --- CONTRIBUTE.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index cf7d5a3..c43a67b 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,3 +1,28 @@ # CONTRIBUTE -`git config --local core.hooksPath .githooks/` +This file is not completed yet and still under devlopement + +## Steps to work on the project + +``` +node: 18.13.0 +npm: 8.19.2 +``` + +### 1. Install dependencies + +``` +$ npm install +``` + +## 2. Setup Git hooks + +``` +$ git config --local core.hooksPath .githooks/ +``` + +## 3. Build project + +``` +$ npm run build +```