Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: simplify contributing by adding instructions #1071

Merged
merged 1 commit into from
Apr 16, 2024
Merged

docs: simplify contributing by adding instructions #1071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ deps/*
.DS_Store

.vscode
.idea
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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,
Expand Down