From d20356f6389331c81fa04a2e80a9fd2e8281f9e1 Mon Sep 17 00:00:00 2001
From: Martijn Imhoff <info@martijnimhoff.nl>
Date: Wed, 17 Apr 2024 00:22:20 +0200
Subject: [PATCH] docs: simplify contributing by adding instructions (#1071)

---
 .gitignore      | 1 +
 CONTRIBUTING.md | 9 +++++++++
 2 files changed, 10 insertions(+)

diff --git a/.gitignore b/.gitignore
index 1b6d3a6a..ee3eed8a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,3 +12,4 @@ deps/*
 .DS_Store
 
 .vscode
+.idea
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b40d275c..9c916206 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,6 +13,7 @@ so if you feel something is missing feel free to send a pull request.
   * [Contributor Agreement](#contributor-agreement)
 
 [How Can I Contribute?](#how-can-i-contribute)
+  * [Setting up the repository](#setting-up-the-repository)
   * [Reporting Bugs](#reporting-bugs)
   * [Suggesting Enhancements](#suggesting-enhancements)
   * [Pull Requests](#pull-requests)
@@ -37,6 +38,14 @@ Not currently required.
 
 ## How can I contribute?
 
+### Setting up the repository
+
+To set up the library locally, do the following:
+
+1) Clone this repository.
+2) Install librdkafka with `git submodule update --init --recursive`
+3) Install the dependencies `npm install`
+
 ### Reporting Bugs
 
 Please use __Github Issues__ to report bugs. When filling out an issue report,