From 2e3aa8e77d29985c227b695654ef91de46bf1d15 Mon Sep 17 00:00:00 2001 From: laaraujo Date: Thu, 9 May 2024 19:25:55 -0300 Subject: [PATCH] Add "Contributing" section to main README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index cfd7bdf..8369657 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,22 @@ The following are the icons use in some diagrams from [Jeremy's IT Lab](https:// * CCNA Course from [Jeremy's IT Lab](https://www.youtube.com/playlist?list=PLxbwE86jKRgMpuZuLBivzlM8s2Dk5lXBQ) +## Contributing + +```sh +# Clone this repo - https://github.com/laaraujo/ccna-notes +git clone git@github.com:laaraujo/ccna-notes.git + +# Install pre-commit - https://pre-commit.com/ +pip install pre-commit + +# Install markdownlint-cli - https://github.com/igorshubovych/markdownlint-cli +npm install -g markdownlint-cli + +# Setup pre-commit hooks +pre-commit install +``` + ## This repo [laaraujo/ccna-notes](https://github.com/laaraujo/ccna-notes)