文档菜单
文档首页
/
MongoDB Kafka 连接器

如何贡献

我们很高兴接受对 MongoDB Kafka 连接器的贡献,以帮助提高其质量。我们将指导社区贡献,以确保它们符合代码库的标准。请确保您的拉取请求满足以下标准

  • 包含描述您的功能的文档注释

  • 包含覆盖您的功能功能的单元测试

  • 通过 Gradlecheck 任务,该任务包括以下任务

    1. test 任务

    2. integrationTest 任务

    3. spotlessCheck 任务

要开始,请查看源代码,并在您的shell中运行以下命令以创建分支

git clone https://github.com/mongodb/mongo-kafka.git
cd mongo-kafka
git checkout -b <your branch name>

一旦您将更改推送到功能分支,请确保它通过 Gradle 检查。您可以使用以下命令运行检查

./gradlew clean check --continue -Dorg.mongodb.test.uri=<your local mongodb replica set connection uri>

重要

集成测试

您必须有一个本地 MongoDB 副本集运行才能执行 Gradle 集成测试。有关如何设置 MongoDB 副本集的信息,请参阅 MongoDB 手册中的部署副本集

注意

跳过的测试

除非您的代码专门修改了与以下区域相关的连接器行为,否则您可以在 integrationTest 任务中跳过与以下区域相关的测试

  • 特定的 MongoDB 版本

  • 身份验证

您可以通过在本地 MongoDB 副本集中启用身份验证并在您的连接 URI 中指定您的凭据来运行身份验证测试。有关在副本集中启用身份验证的信息,请参阅 MongoDB 手册中的 使用密钥文件身份验证部署副本集

您可以通过部署特定版本的MongoDB本地副本集来运行与该特定MongoDB版本相关的测试。

要了解更多关于连接器源代码的信息,请参阅GitHub 仓库。

要了解更多关于Gradle的信息,请参阅官方Gradle网站。

返回

无效的简历令牌