开始开发

分支

本项目有一个主分支，即 main，请确保 main 在任一时刻都是可编译可使用的。同时本项目还有不同版本对应的分支，您可以自行选择分支进行开发。

修改代码

对于功能性问题请提交至少一个测试用例来验证对现有功能的改动；对于性能相关问题请提交必要的测试数据来证明现有代码的性能缺陷，或是新增代码的性能提升。 在每一次 push 前，请先进行测试。

单元测试

运行所有的单元测试

$ cd build
$ ctest --output-on-failure

功能测试

运行所有的功能测试

$ sudo apt-get install -y mosquitto
$ mosquitto -v &
$ python3 -m pip install -U pip
$ python3 -m pip install -r ft/requirements.txt
$ python3 -m robot --maxerroelines=600 -P ft/ -d ft/reports ft

Pull Request

• 一个 PR 只做一件事，如果有多个 bug 的修复，请对每一个 bug 提交一个 PR；

• PR 流程如下：

  • 先 Fork 本项目，创建自己的 github.com/your/neuron 仓库；
    
  • 克隆自己的 neuron 仓库到本地：

  $ git clone https://github.com/your/neuron.git

  • 例如基于 main 分支创建新的分支；
    
  • 在新创建的分支上作修改并提交修改；
    
  • 在推送修改完成的分支到自己的仓库前，先切换到 main 分支，运行如下指令拉取最新的远端代码：

  $ git pull https://github.com/emqx/neuron.git

  • 如果上一步拉取得到了新的远端代码，则切换到之前自己创建的分支，运行如下指令执行分支合并操作：

  $ git rebase main

  如遇到文件冲突，则需要解决冲突；
  

  • 上一步处理完毕后，就可以把自己创建的分支推送到自己的仓库：

  $ git push origin main

  • 最后，把自己仓库的新推送的分支往 emqx/neuron 对应的分支发 PR 即可；

• 在 PR 的标题和正文中，完整表述此次 PR 解决的问题/新增的功能/代码所做的修改的用意等；

• 耐心等待开发者的回应，我们将很快进行回复。