# 如何贡献很高兴你能读到这篇文章，欢迎加入项目社区，帮助项目成长。 ## 发现 bug ？ - **通过在 GitHub 的[问题](https://github.com/lf-edge/ekuiper/issues)下搜索，确保该错误尚未被报告**。 - 如果你找不到解决该问题的公开问题，[开一个新问题](https://github.com/lf-edge/ekuiper/issues/new)。请确保**标题和清晰的描述**，尽可能多的相关信息，以及**代码样本**或**可执行的测试案例**，以明确问题。 ## 代码和文档贡献欢迎贡献代码以提供功能或修复错误。 ### 一次性设置我们使用 GitHub pull request 来审查提议的代码修改。所以你需要在做出代码贡献之前拥有一个 GitHub 账户。 1. **Fork** eKuiper到你的私人仓库。点击 eKuiper 仓库右上角的 "Fork "按钮。 2. 从你的个人分叉中**克隆**版本库。 `git clone https://github.com//ekuiper.git` 。 3. 添加 eKuiper repo 作为额外的 Git 远程仓库，这样你就可以在本地 repo 和eKuiper 之间进行同步。 ```shell git remote add upstream https://github.com/lf-edge/ekuiper.git ``` 你可以使用你喜欢的IDE或编辑器来开发。你可以在 [Editors and IDEs for GO](https://github.com/golang/go/wiki/IDEsAndTextEditorPlugins) 中找到编辑器对Go工具的支持信息。 ### 创建一个分支你将在你自己的 repo 中的一个分支中进行你的代码开发。创建一个本地分支，初始化为你希望合并到的分支的状态。`master`分支是活跃的开发分支，所以建议将`master`设为基础分支。 ```shell $ git fetch upstream $ git checkout -b upstream/master ``` ### 代码惯例 - 在提交代码变更之前，使用 `go fmt` 来格式化你的代码。 - 配置文件中的配置键使用 camel 大小写格式。 ### 调试你的代码以 GoLand 为例，开发者可以对代码进行调试。 1. 调试整个程序。确保 [Makefile](../../Makefile) build_prepare 部分提到的所有目录都在你的eKuiper根路径中创建。添加你的断点。打开 `cmd/kuiperd/main.go` 。在主函数中，你会发现标尺上有一个绿色的三角形，点击它并选择调试。然后创建你的流/规则，让它运行到你的断点，调试器会在那里暂停。 2. 要调试一小部分代码，我们建议写一个单元测试并调试它。你可以到任何一个测试文件中，找到同样的绿色三角形，在调试模式下运行。例如，`pkg/cast/cast_test.go` TestMapConvert_Funcs 可以作为调试运行。 ### 测试 eKuiper 项目利用 Github actions 来运行单元测试和 FVT（功能验证测试），所以请看一下 PR 状态的运行结果，并确保所有的测试用例都能成功运行。 - 如果有必要，请编写 Golang 单元测试案例来测试你的代码。 - [FVT测试案例](../../test/README.md) 将随着任何PR提交而被触发，所以请确保这些测试案例能够成功运行。 ### 许可所有贡献给eKuiper的代码都将在Apache License V2下授权。你需要确保你添加的每个新文件都有正确的许可证头。 ### Signoff Sifnoff 是为了证明提交的来源。它是提交给这个项目的必要条件。如果你设置了你的`user.name`和`user.email`的 git 配置，你可以用`git commit -s`自动签署你的提交。每次提交都必须签名。 ### 同步在提交 PR 之前，你应该用目标分支的最新改动来更新你的分支。我们倾向于使用 rebase 而不是 merge，以避免不必要的合并提交。 ```shell git fetch upstream git rebase upstream/master ``` 假设你 forked repo 名称是默认的`origin`，使用如下指令推送改动到你的 forked repo。假设你 forked repo 名称是默认的`origin`。如果你在最后一次推送前重新建立了 git 历史，请添加 `-f` 来强制推送这些变化。 ```shell git push origin -f ``` ### 提交修改 `master` 分支是活跃的开发分支，所以建议将 `master` 设为基础分支，并在 `master` 分支下创建PR 组织你的提交，使提交者在审查时更容易。提交者通常喜欢多个小的拉动请求，而不是一个大的拉动请求。在一个拉动请求中，最好有相对较少的提交，将问题分解成合理的步骤。对于大多数 PR ，你可以将你的修改压缩到一个提交。你可以使用下面的命令来重新排序、合并、编辑或改变单个提交的描述。 ```shell git rebase -i upstream/master ``` 确保你的所有提交都符合[提交信息指南](#提交信息指南)。然后你会推送到你 forked 的 repo 上的分支，然后导航到 eKuiper repo 创建一个 PR 。我们的 GitHub repo 提供了基于 GitHub actions的自动化测试。请确保这些测试通过。我们将在所有测试通过后审查代码。 ### 提交信息指南每条提交信息都由一个 **header** ，一个 **body** 和一个 **footer** 组成。header 包含三个部分：**类型**，**范围**和**主题**。 ``` <类型>(<范围>): <主题> <空行> <空行>