You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
-
# Contributing to `node-rdkafka`
1
+
# Contributing to `confluent-kafka-js`
2
2
3
3
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4
4
5
-
The following is a set of guidelines for contributing to `node-rdkafka`
6
-
which is hosted in the [Blizzard Organization](https://github.com/blizzard)
5
+
The following is a set of guidelines for contributing to `confluent-kafka-js`
6
+
which is hosted by [Confluent Inc.](https://github.com/confluentinc)
7
7
on GitHub. This document lists rules, guidelines, and help getting started,
8
8
so if you feel something is missing feel free to send a pull request.
9
9
@@ -144,7 +144,7 @@ In short:
144
144
145
145
## Editor
146
146
147
-
I began using Visual Studio code to develop on `node-rdkafka`. If you use it you can configure the C++ plugin to resolve the paths needed to inform your intellisense. This is the config file I am using on a mac to resolve the required paths:
147
+
Using Visual Studio code to develop on `confluent-kafka-js`. If you use it you can configure the C++ plugin to resolve the paths needed to inform your intellisense. This is the config file I am using on a mac to resolve the required paths:
148
148
149
149
`c_cpp_properties.json`
150
150
```
@@ -198,7 +198,7 @@ You can add breakpoints and so on after that.
198
198
The librdkafka should be periodically updated to the latest release in https://github.com/edenhill/librdkafka/releases
199
199
200
200
Steps to update:
201
-
1. Update the `librdkafka` property in [`package.json`](https://github.com/Blizzard/node-rdkafka/blob/master/package.json) to the desired version.
201
+
1. Update the `librdkafka` property in [`package.json`](https://github.com/confluentinc/confluent-kafka-js/blob/master/package.json) to the desired version.
202
202
203
203
1. Update the librdkafka git submodule to that versions release commit (example below)
204
204
@@ -209,7 +209,7 @@ Steps to update:
209
209
210
210
If you get an error during that checkout command, double check that the submodule was initialized / cloned! You may need to run `git submodule update --init --recursive`
211
211
212
-
1. Update [`config.d.ts`](https://github.com/Blizzard/node-rdkafka/blob/master/config.d.ts) and [`errors.d.ts`](https://github.com/Blizzard/node-rdkafka/blob/master/errors.d.ts) TypeScript definitions by running:
212
+
1. Update [`config.d.ts`](https://github.com/confluentinc/confluent-kafka-js/blob/master/config.d.ts) and [`errors.d.ts`](https://github.com/confluentinc/confluent-kafka-js/blob/master/errors.d.ts) TypeScript definitions by running:
213
213
```bash
214
214
node ci/librdkafka-defs-generator.js
215
215
```
@@ -219,7 +219,7 @@ Steps to update:
219
219
220
220
1. Run unit tests: `npm run test`
221
221
222
-
1. Update the version numbers referenced in the [`README.md`](https://github.com/Blizzard/node-rdkafka/blob/master/README.md) file to the new version.
222
+
1. Update the version numbers referenced in the [`README.md`](https://github.com/confluentinc/confluent-kafka-js/blob/master/README.md) file to the new version.
I am looking for *your* help to make this project even better! If you're interested, check [this out](https://github.com/Blizzard/node-rdkafka/issues/628)
10
+
I am looking for *your* help to make this project even better! If you're interested, check [this out](https://github.com/confluentinc/confluent-kafka-js/issues/628)
15
11
16
12
# Overview
17
13
18
-
The `node-rdkafka` library is a high-performance NodeJS client for [Apache Kafka](http://kafka.apache.org/) that wraps the native [librdkafka](https://github.com/edenhill/librdkafka) library. All the complexity of balancing writes across partitions and managing (possibly ever-changing) brokers should be encapsulated in the library.
14
+
The `confluent-kafka-js` library is a high-performance NodeJS client for [Apache Kafka](http://kafka.apache.org/) that wraps the native [librdkafka](https://github.com/edenhill/librdkafka) library. All the complexity of balancing writes across partitions and managing (possibly ever-changing) brokers should be encapsulated in the library.
19
15
20
16
__This library currently uses `librdkafka` version `2.3.0`.__
21
17
22
18
## Reference Docs
23
19
24
-
To view the reference docs for the current version, go [here](https://blizzard.github.io/node-rdkafka/current/)
20
+
To view the reference docs for the current version, go [here](https://confluentinc.github.io/confluent-kafka-js/current/)
25
21
26
22
## Contributing
27
23
28
-
For guidelines on contributing please see [CONTRIBUTING.md](https://github.com/blizzard/node-rdkafka/blob/master/CONTRIBUTING.md)
24
+
For guidelines on contributing please see [CONTRIBUTING.md](https://github.com/confluentinc/confluent-kafka-js/blob/master/CONTRIBUTING.md)
29
25
30
26
## Code of Conduct
31
27
@@ -41,7 +37,7 @@ Play nice; Play fair.
41
37
42
38
### Mac OS High Sierra / Mojave
43
39
44
-
OpenSSL has been upgraded in High Sierra and homebrew does not overwrite default system libraries. That means when building node-rdkafka, because you are using openssl, you need to tell the linker where to find it:
40
+
OpenSSL has been upgraded in High Sierra and homebrew does not overwrite default system libraries. That means when building confluent-kafka-js, because you are using openssl, you need to tell the linker where to find it:
45
41
46
42
```sh
47
43
export CPPFLAGS=-I/usr/local/opt/openssl/include
@@ -56,7 +52,7 @@ __NOTE:__ From the `librdkafka` docs
56
52
57
53
### Alpine
58
54
59
-
Using Alpine Linux? Check out the [docs](https://github.com/Blizzard/node-rdkafka/blob/master/examples/docker-alpine.md).
55
+
Using Alpine Linux? Check out the [docs](https://github.com/confluentinc/confluent-kafka-js/blob/master/examples/docker-alpine.md).
60
56
61
57
### Windows
62
58
@@ -65,7 +61,7 @@ Windows build **is not** compiled from `librdkafka` source but it is rather link
65
61
Requirements:
66
62
*[node-gyp for Windows](https://github.com/nodejs/node-gyp#on-windows)
67
63
68
-
**Note:** I _still_ do not recommend using `node-rdkafka` in production on Windows. This feature was in high demand and is provided to help develop, but we do not test against Windows, and windows support may lag behind Linux/Mac support because those platforms are the ones used to develop this library. Contributors are welcome if any Windows issues are found :)
64
+
**Note:** I _still_ do not recommend using `confluent-kafka-js` in production on Windows. This feature was in high demand and is provided to help develop, but we do not test against Windows, and windows support may lag behind Linux/Mac support because those platforms are the ones used to develop this library. Contributors are welcome if any Windows issues are found :)
69
65
70
66
## Tests
71
67
@@ -83,16 +79,16 @@ You can run both types of tests by using `Makefile`. Doing so calls `mocha` in y
83
79
84
80
# Usage
85
81
86
-
You can install the `node-rdkafka` module like any other module:
82
+
You can install the `confluent-kafka-js` module like any other module:
87
83
88
84
```
89
-
npm install node-rdkafka
85
+
npm install confluent-kafka-js
90
86
```
91
87
92
88
To use the module, you must `require` it.
93
89
94
90
```js
95
-
constKafka=require('node-rdkafka');
91
+
constKafka=require('confluent-kafka-js');
96
92
```
97
93
98
94
## Configuration
@@ -117,10 +113,10 @@ The library currently supports the following callbacks:
117
113
118
114
This library includes two utility functions for detecting the status of your installation. Please try to include these when making issue reports where applicable.
119
115
120
-
You can get the features supported by your compile of `librdkafka` by reading the variable "features" on the root of the `node-rdkafka` object.
116
+
You can get the features supported by your compile of `librdkafka` by reading the variable "features" on the root of the `confluent-kafka-js` object.
@@ -382,7 +378,7 @@ const consumer = new Kafka.KafkaConsumer({
382
378
383
379
### Commits
384
380
385
-
When you commit in `node-rdkafka`, the standard way is to queue the commit request up with the next `librdkafka` request to the broker. When doing this, there isn't a way to know the result of the commit. Luckily there is another callback you can listen to to get this information
381
+
When you commit in `confluent-kafka-js`, the standard way is to queue the commit request up with the next `librdkafka` request to the broker. When doing this, there isn't a way to know the result of the commit. Luckily there is another callback you can listen to to get this information
`node-rdkafka` now supports the admin client for creating, deleting, and scaling out topics. The `librdkafka` APIs also support altering configuration of topics and broker, but that is not currently implemented.
595
+
`confluent-kafka-js` now supports the admin client for creating, deleting, and scaling out topics. The `librdkafka` APIs also support altering configuration of topics and broker, but that is not currently implemented.
0 commit comments