@@ -7,33 +7,11 @@ 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
10
- #### Table Of Contents
11
-
12
- [ What should I know before I get started?] ( #what-should-i-know-before-i-get-started )
13
- * [ Contributor Agreement] ( #contributor-agreement )
14
-
15
- [ How Can I Contribute?] ( #how-can-i-contribute )
16
- * [ Reporting Bugs] ( #reporting-bugs )
17
- * [ Suggesting Enhancements] ( #suggesting-enhancements )
18
- * [ Pull Requests] ( #pull-requests )
19
-
20
- [ Styleguides] ( #styleguides )
21
- * [ Git Commit Messages] ( #git-commit-messages )
22
- * [ JavaScript Styleguide] ( #javascript-styleguide )
23
- * [ C++ Styleguide] ( #c++-styleguide )
24
- * [ Specs Styleguide] ( #specs-styleguide )
25
- * [ Documentation Styleguide] ( #documentation-styleguide )
26
-
27
- [ Debugging] ( #debugging )
28
- * [ Debugging C++] ( #debugging-c )
29
-
30
- [ Updating librdkafka version] ( #updating-librdkafka-version )
31
-
32
10
## What should I know before I get started?
33
11
34
12
### Contributor Agreement
35
13
36
- Not currently required .
14
+ Required (please follow instructions after making any Pull Requests) .
37
15
38
16
## How can I contribute?
39
17
@@ -49,6 +27,10 @@ replicas, partitions, and brokers you are connecting to, because some issues
49
27
might be related to Kafka. A list of ` librdkafka ` configuration key-value pairs
50
28
also helps.
51
29
30
+ Adding the property ` debug ` in your ` librdkafka ` configuration will help us. A list of
31
+ possible values is available [ here] ( https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md ) ,
32
+ but you can set it to ` all ` if verbose logs are okay.
33
+
52
34
### Suggesting Enhancements
53
35
54
36
Please use __ Github Issues__ to suggest enhancements. We are happy to consider
@@ -59,6 +41,9 @@ library's core.
59
41
60
42
### Pull Requests
61
43
44
+ NOTE: Pull requests while the library in EA are discouraged, as we are still
45
+ working on the API and may make breaking changes.
46
+
62
47
* Include new test cases (either end-to-end or unit tests) with your change.
63
48
* Follow our style guides.
64
49
* Make sure all tests are still passing and the ` linter ` does not report any issues.
@@ -114,7 +99,8 @@ In short:
114
99
115
100
### Specs Styleguide
116
101
117
- * Write all JavaScript tests by using the ` mocha ` testing framework.
102
+ * Write JavaScript tests by using the ` mocha ` testing framework for the
103
+ non-promisified API and ` jest ` for the promisified API.
118
104
* All ` mocha ` tests should use exports syntax.
119
105
* All ` mocha ` test files should be suffixed with ` .spec.js ` instead of ` .js ` .
120
106
* Unit tests should mirror the JavaScript files they test (for example,
@@ -169,6 +155,26 @@ Using Visual Studio code to develop on `confluent-kafka-js`. If you use it you c
169
155
}
170
156
```
171
157
158
+ ## Tests
159
+
160
+ This project includes three types of tests in this project:
161
+ * end-to-end integration tests (` mocha ` )
162
+ * unit tests (` mocha ` )
163
+ * integration tests for promisified API (` jest ` )
164
+
165
+ You can run all types of tests by using ` Makefile ` . Doing so calls ` mocha ` or ` jest ` in your locally installed ` node_modules ` directory.
166
+
167
+ * Before you run the tests, be sure to init and update the submodules:
168
+ 1 . ` git submodule init `
169
+ 2 . ` git submodule update `
170
+ * To run the unit tests, you can run ` make lint ` or ` make test ` .
171
+ * To run the promisified integration tests, you can use ` make promisified_test ` .
172
+ You must have a running Kafka installation available. By default, the test tries to connect to ` localhost:9092 ` ;
173
+ however, you can supply the ` KAFKA_HOST ` environment variable to override this default behavior.
174
+ * To run the integration tests, you can use ` make e2e ` .
175
+ You must have a running Kafka installation available. By default, the test tries to connect to ` localhost:9092 ` ;
176
+ however, you can supply the ` KAFKA_HOST ` environment variable to override this default behavior. Run ` make e2e ` .
177
+
172
178
## Debugging
173
179
174
180
### Debugging C++
0 commit comments