Skip to content

Commit b2dc440

Browse files
docs: Enhance Contributing Guide (#2085)
Enhance Contributing Guide Co-authored-by: Thang Le <[email protected]>
1 parent 61debe7 commit b2dc440

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

CONTRIBUTING_GUIDE.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,27 +34,26 @@ The usual workflow of code contribution is:
3434

3535
Pull Request reviews are done on a regular basis.
3636

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.
4241
4342
## Requirement
4443

4544
| Requirement | Version |
4645
|------------------------|------------|
4746
| Compiling requirements | JDK 17 |
48-
| Compiling requirements | Scale 2.13 |
47+
| Compiling requirements | Scala 2.13 |
4948
| Running requirements | JDK 17 |
5049

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
5251
5352
## Local Debug with IDEA
5453

5554
### Gradle
5655

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.
5857

5958
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.
6059

@@ -64,7 +63,7 @@ It is not recommended to manually install Gradle. The gradlew script in the root
6463
```
6564

6665
### 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.
6867

6968
If you are using localstack then create a bucket with the following command:
7069
```
@@ -95,7 +94,7 @@ Format Metadata Catalog:
9594
```
9695
bin/kafka-storage.sh format -t $KAFKA_CLUSTER_ID -c config/kraft/server.properties
9796
```
98-
### IDEA Start Configuration
97+
### IDE Start Configuration
9998
| Item | Value |
10099
|------------------------|------------|
101100
| Main | core/src/main/scala/kafka/Kafka.scala |

0 commit comments

Comments
 (0)