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
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Contributing to `confluent-kafka-js`
1
+
# Contributing to `confluent-kafka-javascript`
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 `confluent-kafka-js`
5
+
The following is a set of guidelines for contributing to `confluent-kafka-javascript`
6
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.
@@ -123,7 +123,7 @@ In short:
123
123
124
124
## Editor
125
125
126
-
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:
126
+
Using Visual Studio code to develop on `confluent-kafka-javascript`. 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:
The librdkafka should be periodically updated to the latest release in https://github.com/confluentinc/librdkafka/releases
208
208
209
209
Steps to update:
210
-
1. Update the `librdkafka` property in [`package.json`](https://github.com/confluentinc/confluent-kafka-js/blob/master/package.json) to the desired version.
210
+
1. Update the `librdkafka` property in [`package.json`](https://github.com/confluentinc/confluent-kafka-javascript/blob/master/package.json) to the desired version.
211
211
212
212
1. Update the librdkafka git submodule to that versions release commit (example below)
213
213
@@ -218,7 +218,7 @@ Steps to update:
218
218
219
219
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`
220
220
221
-
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:
221
+
1. Update [`config.d.ts`](https://github.com/confluentinc/confluent-kafka-javascript/blob/master/config.d.ts) and [`errors.d.ts`](https://github.com/confluentinc/confluent-kafka-javascript/blob/master/errors.d.ts) TypeScript definitions by running:
222
222
```bash
223
223
node ci/librdkafka-defs-generator.js
224
224
```
@@ -227,7 +227,7 @@ Steps to update:
227
227
228
228
1. Run unit tests: `npm run test`
229
229
230
-
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.
230
+
1. Update the version numbers referenced in the [`README.md`](https://github.com/confluentinc/confluent-kafka-javascript/blob/master/README.md) file to the new version.
Copy file name to clipboardExpand all lines: INTRODUCTION.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,10 @@ The library currently supports the following callbacks:
22
22
23
23
This library includes two utility functions for detecting the status of your installation. Please try to include these when making issue reports where applicable.
24
24
25
-
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.
25
+
You can get the features supported by your compile of `librdkafka` by reading the variable "features" on the root of the `confluent-kafka-javascript` object.
@@ -293,7 +293,7 @@ const consumer = new Kafka.KafkaConsumer({
293
293
294
294
#### Commits
295
295
296
-
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
296
+
When you commit in `confluent-kafka-javascript`, 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
`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.
510
+
`confluent-kafka-javascript` 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