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_GUIDE.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,27 +34,26 @@ The usual workflow of code contribution is:
34
34
35
35
Pull Request reviews are done on a regular basis.
36
36
37
-
:::info
38
-
Please make sure you respond to our feedback/questions and sign our CLA.
39
-
40
-
Pull Requests without updates will be closed due inactivity.
41
-
:::
37
+
> [!NOTE]
38
+
> Please make sure you respond to our feedback/questions and sign our CLA.
39
+
>
40
+
> Pull Requests without updates will be closed due inactivity.
42
41
43
42
## Requirement
44
43
45
44
| Requirement | Version |
46
45
|------------------------|------------|
47
46
| Compiling requirements | JDK 17 |
48
-
| Compiling requirements |Scale 2.13 |
47
+
| Compiling requirements |Scala 2.13 |
49
48
| Running requirements | JDK 17 |
50
49
51
-
> Tips: You can refer the [document](https://www.scala-lang.org/download/2.13.12.html) to install Scale 2.13
50
+
> Tips: You can refer the [document](https://www.scala-lang.org/download/2.13.12.html) to install Scala 2.13
52
51
53
52
## Local Debug with IDEA
54
53
55
54
### Gradle
56
55
57
-
Build AutoMQ is the same with Apache Kafka. Kafka uses Gradle as its project management tool. The management of Gradle projects is based on scripts written in Groovy syntax, and within the Kafka project, the main project management configuration is found in the build.gradle file located in the root directory, which serves a similar function to the root POM in Maven projects. Gradle also supports configuring a build.gradle for each module separately, but Kafka does not do this; all modules are managed by the build.gradle file in the root directory.
56
+
Building AutoMQ is the same as Apache Kafka. Kafka uses Gradle as its project management tool. The management of Gradle projects is based on scripts written in Groovy syntax, and within the Kafka project, the main project management configuration is found in the `build.gradle` file located in the root directory, which serves a similar function to the root POM in Maven projects. Gradle also supports configuring a `build.gradle` for each module separately, but Kafka does not do this; all modules are managed by the build.gradle file in the root directory.
58
57
59
58
It is not recommended to manually install Gradle. The gradlew script in the root directory will automatically download Gradle for you, and the version is also specified by the gradlew script.
60
59
@@ -64,7 +63,7 @@ It is not recommended to manually install Gradle. The gradlew script in the root
64
63
```
65
64
66
65
### Prepare S3 service
67
-
Refer this [doc](https://docs.localstack.cloud/getting-started/installation/) to install localstack to mock a local s3 service or use AWS S3 service directly.
66
+
Refer to this [documentation](https://docs.localstack.cloud/getting-started/installation/) to install `localstack` to mock a local s3 service or use AWS S3 service directly.
68
67
69
68
If you are using localstack then create a bucket with the following command:
70
69
```
@@ -95,7 +94,7 @@ Format Metadata Catalog:
95
94
```
96
95
bin/kafka-storage.sh format -t $KAFKA_CLUSTER_ID -c config/kraft/server.properties
0 commit comments