如何帮助修改IoTDB代码并提交PR

前言

本人北邮 IoT 大三小白一枚，假期开始时有幸得到了来 IoTDB 项目实习的机会。IoTDB 是一款清华学生团队的原创物联网时序数据库，纯开源项目，目前已经从 Apache 毕业，也在行业内得到了应用。相比以 MySQL 为首的传统数据库，IoTDB 无论是从数据结构、存储方式还是处理速度、轻量化等方面都有着显著的优势，满足了工业物联网领域的海量数据存储、高速数据读取和复杂数据分析需求。

在此附上 Apache IoTDB 官网

IoTDB 项目的维护和更新很大一部分依赖于Apache社区内各路大神的群策群力，欢迎大家加入 IoTDB 的大家庭，让 IoTDB 变得越来越好！请点此链接查看详细步骤。

一、前期准备

请确保以下开发环境已正确部署，本文 IDE 以 ItelliJ IDEA 为例

• JDK1.8 及以上版本并已配好环境变量
• Maven 已安装到本地并配好环境变量。不推荐使用 IDEA 嵌入的 Maven，请前往 Maven官网下载
• Git 已安装，请前往 Git官网 下载
• GitHub 已登录
• 检查 IDEA 的 Maven 设置，确保 Maven 路径已选择本地并且 Override 用户设定
  

二、在Jira上打开问题

1. 前往 Jira：https://issues.apache.org/jira/projects/IOTDB/issues打开问题列表
   

2. 浏览问题描述，并选择一个问题解决，这里以 IOTDB-2512 为例

三、Fork仓库

在 GitHub 的 apache/iotdb仓库 页面点击右上角的 Fork，将apache/iotdb项目添加到你的 GitHub 仓库

四、配置Git

1. 打开 Git 命令行，cd 到你想要存放项目文件的本地目录
   

2. 输入以下命令，将项目文件克隆到该目录（请将 <your_github_name> 替换为你的 GitHub 用户名）

git clone https://github.com/<your_github_name>/iotdb.git

clone 完成后，origin 会默认指向 github 上的远程 fork 地址。运行结果如下：

3. 将 apache/iotdb 添加为本地仓库的远程分支 upstream

cd iotdb
git remote add upstream https://github.com/apache/iotdb.git

4. 执行以下命令检查远程仓库设置是否正确

git remote -v

5. 新建远程分支

git checkout -b IOTDB-2512

五、修改代码并格式化

1. 在 IDEA 中打开iotdb项目文件夹，等待Maven自动加载完成，便可以进行代码修改
2. 修改完成后再IDEA的命令行中执行以下命令进行代码格式化：

mvn spotless:apply

六、将代码提交到远程分支

git commit -a -m "<you_commit_message>"
git push origin IOTDB-2512

七、创建Pull Request

1. 打开GitHub网页，进入自己仓库中的iotdb目录，并切换到刚刚创建的分支 IOTDB-2512
   
2. 依次点击Pull Request和create a pull request
   
3. 在 PR 的标题开头加上 [IOTDB-xxxx] 添加标题并填写描述，最后点击Create pull request提交PR
   

八、运行测试

系统测试会自动进行，测试时间较长，请耐心等待。测试通过后经管理员通过即可合并到Master分支。若测试未通过，只需查看报错，修改代码并格式化后重新 commit 和 push（步骤六）即可，PR会自动检测最新的修改并运行测试

九、删除分支

成功合并解决issue后，请删除该分支