中文版 | In English

入门资料

用户手册：http://iotdb.apache.org/UserGuide/Master/Data-Concept/Data-Model-and-Terminology.html
最新设计文档：https://cwiki.apache.org/confluence/display/IOTDB/Home
如何调试 IoTDB server：https://my.oschina.net/u/3664598/blog/4500279
入门 issue（easy-fix）：

• Jira https://issues.apache.org/jira/issues/?jql=project = IOTDB AND resolution = Unresolved AND labels in (easy-fix, easy-fixed) ORDER BY priority DESC, updated DESC
• Github Issue Easy-Fixed

使用问题可提交 Discussion：https://github.com/apache/iotdb/discussions
对代码的修改和讨论可提交 Jira issue：https://issues.apache.org/jira/projects/IOTDB/issues
入门系列教程：https://my.oschina.net/u/3664598?tab=newest&catalogId=0

社区最新工作进展

• 发版计划：https://cwiki.apache.org/confluence/display/IOTDB/since v0.14
• 任务管理：https://issues.apache.org/jira/projects/IOTDB/issues/IOTDB-2525?filter=allissues
• 当前正在做的 Issue：https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=492&projectKey=IOTDB

联系我们

在使用 IoTDB 的过程中，如果您发现任何问题、有任何新的想法，可以通过 Apache 邮件列表、QQ 群、微信群参与到 IoTDB 的社区建设中。

订阅邮件列表

• 发送订阅邮件。使用想接收邮件的邮箱向 [email protected] 发送一封邮件，主题内容不限。
• 确认订阅邮件。完成上一步后，您将收到一封来自 iotdb.apache.org 结尾的确认订阅邮件。向该邮件再次发一封主题内容不限的邮件即可确认订阅。
• 至此，您可以通过订阅的邮箱接收及回复邮件，或通过查看 归档邮件 来跟踪之前的邮件对话。

Slack

• https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg

QQ群

• Apache IoTDB 交流群：659990460

微信群

• 添加好友 apache_iotdb，我们会邀请您进群。

公众号：Apache IoTDB

• 公众号内容：包括 IoTDB 的使用教程、源码解析、实际案例、社区活动等，欢迎投稿！
• 关注方式：微信搜索 Apache-IoTDB，或扫描下方二维码即可关注我们。

案例分享

如果您正在使用 IoTDB，欢迎在这个 调研问卷 分享您使用 IoTDB 的经验，非常期待您的参与。

贡献指南

提交 Jira issue

如果您有任何希望 IoTDB 支持的新功能、期望 IoTDB 的改进提升或者发现了 bug，欢迎您在 Jira 或着 Github 上提 issue。

• 在提交 issue 之前，请先查看 issue 列表或简单搜索，确定该 issue 不重复。
• 新建一个 issue 并选择您的 issue 类型。
• 使用一个清晰并有描述性的标题来定义 issue。
• 根据模板填写必要信息。
• 在提交 issue 之后，对该 issue 分配合适的标签。如：Wish，Improvement，Bug 等。
• 请对自己提交的 issue 保持关注，在讨论中进一步提供必要信息。

邮件讨论(英文)

• 如果您第一次参与邮件列表可以简单介绍一下自己。
• 开发功能前可以发邮件声明一下自己想做的任务。
• 设计文档讨论

贡献文档

IoTDB 所有官网上的内容都在项目根目录的 docs 中：

• docs/UserGuide: 用户手册-英文版
• docs/zh/UserGuide: 用户手册-中文版
• docs/Community: 社区-英文版
• docs/zh/Community: 社区-中文版
• docs/Development: 开发指南-英文版
• docs/zh/Development: 开发指南-中文版

官网用户手册版本和分支的对应关系：

• latest -> master
• major_version.x -> rel/major_version （如 0.10.x -> rel/0.10）

注意事项：

• Markdown 中的图片可上传至 apache/iotdb-bin-resources 获得 url

贡献代码

可以到 jira 上领取现有 issue 或者自己创建 issue 再领取，评论说我要做这个 issue 就可以。

• 从 iotdb 的仓库上 fork 一个分支到您自己的仓库来开始工作，clone 到本地并设置 upstream 为 apache/iotdb 的仓库。

git clone https://github.com/自己的仓库/iotdb.git
git remote add upstream https://github.com/apache/iotdb.git

• 进入 iotdb 根目录，拉取最新 master 分支，从 master 切出新的分支，分支名根据这个分支的功能决定，一般叫 f_new_feature(如f_storage_engine) 或者 fix_bug(如fix_query_cache_bug)

cd iotdb
git pull upstream master
git checkout -b "f_storage_engine"

• 在 idea 中添加 code style 为 根目录的 java-google-style.xml
• 修改代码，增加测试用例（单元测试、集成测试）
  • 集成测试参考: server/src/test/java/org/apache/iotdb/db/integration/IoTDBTimeZoneIT
• 提交 PR, 以 [IOTDB-jira号] 或者[ISSUE-github issue号]开头

git add 修改代码
git commit -m 'commit log'
git push origin f_storage_engine

• 发邮件到 dev 邮件列表：(I've submitted a PR for issue IOTDB-xxx [link])
• 根据其他人的审阅意见进行修改，继续更新，直到合并
• 关闭 jira 或 Github issue

注意: 为了让您的 id 显示在 contributor 列表中，别忘了以下设置：

git config --global user.name "username"
git config --global user.email "[email protected]"

In English

Material

Concept and UserGuide: http://iotdb.apache.org/UserGuide/Master/Data-Concept/Data-Model-and-Terminology.html
Design doc before 0.11: http://iotdb.apache.org/SystemDesign/Architecture/Architecture.html
Design doc since 0.11: https://cwiki.apache.org/confluence/display/IOTDB/Home
How to debug IoTDB Server: https://my.oschina.net/u/3664598/blog/4500279
Getting Start: https://my.oschina.net/u/3664598?tab=newest&catalogId=0
Easy-fix Issue:

• Jira https://issues.apache.org/jira/issues/?jql=project = IOTDB AND resolution = Unresolved AND labels in (easy-fix, easy-fixed) ORDER BY priority DESC, updated DESC
• Github Issue Easy-Fixed

New Status of Community

Release roadmap：https://cwiki.apache.org/confluence/display/IOTDB/since v0.14
Issue management：https://issues.apache.org/jira/projects/IOTDB/issues/IOTDB-2525?filter=allissues
Currently doing issues：https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=492&projectKey=IOTDB

Contact Us

If you encounter any problem or have any new idea using IoTDB, you can participate in the community of IoTDB through the Apache mailing list, QQ group, WeChat group.

Subscribe to Mailing List

• Send a subscription email：Send an email to [email protected] using the email address you want to receive emails from, with any subject.
• Confirm your subscription：After completing the previous step, you will receive a confirmation email from iotdb.apache.org with your subscription. Confirm your subscription by sending another email to that email with any subject you wish.
• At this point, you can receive and reply to emails from your subscribed email address, or track previous email conversations by viewing the archived emails.

Slack

• https://join.slack.com/t/apacheiotdb/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg

QQ Group

• Apache IoTDB User Group：659990460

Wechat Group

• Add friend: apache_iotdb, and then we'll invite you to the group.

WeChat Official Account：Apache IoTDB

• Contents in Official account: tutorials on using IoTDB, source code parsing, case analyzing, community events, etc., looking forward to new ideas!
• Follow us by searching Apache-IoTDB on WeChat, or by scanning the QR code below.

Case Sharing

If you are currently using IoTDB, please share your experience with IoTDB in this survey, and we look forward to your participation.

Contribution Guidelines

Submit issue

If there is any new feature you'd like IoTDB to support, improvements you'd like IoTDB to improve, or bugs you've found, you're welcome to submit an issue in Jira or on Github.

• Check the issue list or do a simple search before you submit an issue to make sure the issue isn't a repetitive one.
• Create a new issue and choose your issue type.
• Use a clear and descriptive title to define the issue.
• Fill in the necessary information according to the template.
• Assign the appropriate tags to the issue after submitting the issue,. For example: Wish, Improve, Bug, etc.
• Keep an eye on your own issue, and provide further necessary information in the discussion.

Email Discussions

• If it is the first time you participate in the mailing list, you can briefly introduce yourself.
• Send an email declaring the task you want to do Before developing the feature. (Hi，I'm working on issue IOTDB-XXX，My plan is ...)
• Discuss on the design document

Contribute wiki documents

Community documentation is stored at Confluence and can be consulted when using and contributing to IoTDB. Feature development and experimentation on IoTDB can also be logged on it.

Contribute Documents

All of IoTDB's official website content is in docs in the project's root directory.

• docs/SystemDesign: System Design Documentation - English version
• docs/zh/SystemDesign: System Design Documentation-Chinese Version
• docs/UserGuide: UserGuide - English Version
• docs/zh/UserGuide: UserGuide - Chinese Version
• docs/Community: Community - English Version
• docs/zh/Community: Community - Chinese Version
• docs/Development: Development Guide - English Version
• docs/zh/Development: Development Guide - Chinese Version

Relation between official versions of user manual and branches：

• latest -> master
• major_version.x -> rel/major_version (e.g. 0.10.x -> rel/0.10)

Caution:

• Images from Markdown can be uploaded to apache/iotdb-bin-resources to get the url.

Contribute Code

Pick up an existing issue on Jira or create a new issue and then pick it up, just comment that I want to do this issue will be fine.

• Fork a branch from the iotdb repository to your own repository to get started, clone to local and set upstream as the apache/iotdb repository.

git clone https://github.com/your own repository/iotdb.git
git remote add upstream https://github.com/apache/iotdb.git

• Go to the root of iotdb, pull the latest master branch, detach a new branch from master, usually called f_new_feature (e.g. f_storage_engine) or fix_bug (e.g. fix_query_cache_bug) depending on the function of the branch.

cd iotdb
git pull upstream master
git checkout -b "f_storage_engine"

• Add java-google-style.xml to the root directory of code style in idea.

• Modify Code and Add test Cases (unit test, integration test)

• Integration test refers to: server/src/test/java/org/apache/iotdb/db/integration/IoTDBTimeZoneIT

• Submit PR, beginning with [IOTDB-jira number]

git add Modify Code
git commit -m 'commit log'
git push origin f_storage_engine

• Email to dev Mailing list:(I've submitted a PR for issue IOTDB-xxx [link])
  Make changes based on others' review comments and continue to update until merged
  Close jira or Github issue

Note: In order for your id to appear in the contributor list, don't forget the following settings:

git config --global user.name "username"
git config --global user.email "[email protected]"

Contributors: HTHou, qiaojialin, JesseZhou-1