Skip to content

Commit d20356f

Browse files
docs: simplify contributing by adding instructions (#1071)
1 parent 364eb16 commit d20356f

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ deps/*
1212
.DS_Store
1313

1414
.vscode
15+
.idea

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ so if you feel something is missing feel free to send a pull request.
1313
* [Contributor Agreement](#contributor-agreement)
1414

1515
[How Can I Contribute?](#how-can-i-contribute)
16+
* [Setting up the repository](#setting-up-the-repository)
1617
* [Reporting Bugs](#reporting-bugs)
1718
* [Suggesting Enhancements](#suggesting-enhancements)
1819
* [Pull Requests](#pull-requests)
@@ -37,6 +38,14 @@ Not currently required.
3738

3839
## How can I contribute?
3940

41+
### Setting up the repository
42+
43+
To set up the library locally, do the following:
44+
45+
1) Clone this repository.
46+
2) Install librdkafka with `git submodule update --init --recursive`
47+
3) Install the dependencies `npm install`
48+
4049
### Reporting Bugs
4150

4251
Please use __Github Issues__ to report bugs. When filling out an issue report,

0 commit comments

Comments
 (0)