新手入门贡献Apache IoTDB

名词解释

1. Issue: 开源社区的一个任务的统称，通常会有一个Issue 列表，用于表示各种任务，比如功能Issue,Bug Issue, Improvement Issue等。
2. PR(Pull Request): 个人理解是一种工作流程，当你在本地感觉开发好或者说完成某个Issue(不一定是代码，有可能是文档等工作)时，准备提交到社区仓库的master分支时，需要提交一个PR。它表示一个提交请求，并不会马上被社区接受，而是会让社区内的其他人知道这个请求，进行Review后，同意该请求之后，才真正算贡献提交成功。
3. JIRA：是一个项目管理工具，里面存放Issue列表，供贡献者进行认领，贡献者认领后可以在上面预估工作时间，开始工作、完成任务后可以关闭该Issue。

文档阅读

一般来说，一个质量比较好的开源项目，其代码仓库的README文件或者官方文档会有比较详细的开发指南。Apache IoTDB也不例外，下面是我列的几个在这当中对我帮助比较大的几个文档。

用户指南: 用户指南

代码贡献指南：代码贡献指南、如何提交PR

设计实现文档:  设计实现文档

• 用户指南：重点是学习该项目的一些功能、概念，这在后面阅读熟悉其代码是很有帮助的，比如在Apache IoTDB里的数据模型：存储组、路径等概念对于理解里面一些类的命名与作用会起到事半功倍的效果。
• 代码贡献指南: 参与Apache IoTDB的一些流程，重点就是订阅官方邮件，在进行相关功能开发时可以先发一个邮件给社区的成员同步一下；在JIRA上领取issue;下载代码、格式化以及调试。特别是调试，在熟悉代码时如果实在不理解可以考虑进行调试。最后就是感觉开发完成，如何提交PR的一个流程介绍。
• 设计实现文档：是社区的一些开发人员编写的一些项目的设计实现流程，不过实话实说，IoTDB的这个文档写的对于小白不是特别友好，我一般更愿意去看代码，如果有困难再去找找相关部分的设计文档辅助代码阅读。

代码阅读

https://github.com/apache/iotdb

订阅邮件列表

Apache 项目都提倡通过邮件列表与社区交流，邮件列表 ([email protected]) 本质上是一个邮箱地址，所有订阅这个邮箱地址的都能收到发往此邮箱的邮件。

订阅方式如下

• 发送订阅邮件：向 [email protected] 发送一封邮件，主题内容不限。

• 确认订阅邮件：完成上一步后，将收到一封来自 iotdb.apache.org 结尾的确认订阅邮件。向该邮件再次发一封主题内容不限的邮件即可确认订阅。

创建开发平台账号

• 【创建 Jira 账号】https://issues.apache.org/jira/projects/IOTDB/issues ，Jira 是我们管理任务的地方，账号用来认领 issue。

• 【创建 Confluence 账号】Home - IOTDB - Apache Software Foundation ，用来写英文设计文档。

• 【发邮件】上述账户创建好后，向邮件列表（[email protected]）发送一封邮件，包括自我介绍以及 jira id 和 Confluence id，社区 PMC 会为账户添加权限。

附自我介绍示例：Hi, I'm xxx, from xxx.

进用户群

• QQ用户群：659990460

• 微信用户群：IoTDB 数据库交流x群

• slack：Join Apache IoTDB Community on Slack | Slack