Google Git
Sign in
apache / iotdb-website / c03d5cb1b2cf5d86294d406fc218e086d06e50fc / . / assets / js / 277.099ab9e3.js
blob: e164b9d0e0d74702dc808822a090f6fbf789f993 [file] [log] [blame]
(window.webpackJsonp=window.webpackJsonp||[]).push([[277],{845:function(e,t,a){"use strict";a.r(t);var i=a(69),r=Object(i.a)({},(function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"一、工作流程"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#一、工作流程"}},[e._v("#")]),e._v(" 一、工作流程")]),e._v(" "),a("h2",{attrs:{id:"主要链接"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#主要链接"}},[e._v("#")]),e._v(" 主要链接")]),e._v(" "),a("p",[e._v("IoTDB 官网：https://iotdb.apache.org/")]),e._v(" "),a("p",[e._v("代码库：https://github.com/apache/iotdb/tree/master")]),e._v(" "),a("p",[e._v("快速上手：http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html")]),e._v(" "),a("p",[e._v("Jira 任务管理：https://issues.apache.org/jira/projects/IOTDB/issues")]),e._v(" "),a("p",[e._v("Wiki 文档管理：https://cwiki.apache.org/confluence/display/IOTDB/Home")]),e._v(" "),a("h2",{attrs:{id:"订阅邮件列表"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#订阅邮件列表"}},[e._v("#")]),e._v(" 订阅邮件列表")]),e._v(" "),a("p",[e._v("邮件列表是 Apache 项目进行技术讨论和用户沟通的地方，订阅邮件列表就可以收到邮件了。")]),e._v(" "),a("p",[e._v("邮件列表地址：dev@iotdb.apache.org")]),e._v(" "),a("p",[e._v("订阅方法：用想接收邮件的邮箱向 dev-subscribe@iotdb.apache.org 发一封邮件，主题内容不限，收到回复后，再次向确认地址发一封确认邮件（确认地址比较长，推荐qq邮箱）。")]),e._v(" "),a("p",[e._v("其他邮件列表:")]),e._v(" "),a("ul",[a("li",[e._v("notifications@iotdb.apache.org (用于接收JIRA通知.)\n"),a("ul",[a("li",[e._v('如果你只想接收个别感兴趣的JIRA通知，你不需要订阅这个列表。你只需要在JIRA issue页面上点击"开始关注这个issue" 或者在这个issue上做评论就行了。')])])]),e._v(" "),a("li",[e._v("commits@iotdb.apache.org (任何代码改动都会通知到此处。该邮件列表邮件数量十分多，请注意。)")]),e._v(" "),a("li",[e._v("reviews@iotdb.apache.org (任何代码审阅意见都会通知到此处。该邮件列表邮件数量十分多，请注意。)")])]),e._v(" "),a("h2",{attrs:{id:"新功能、bug-反馈、改进等"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#新功能、bug-反馈、改进等"}},[e._v("#")]),e._v(" 新功能、Bug 反馈、改进等")]),e._v(" "),a("p",[e._v("所有希望 IoTDB 做的功能或修的 bug，都可以在 Jira 上提 issue")]),e._v(" "),a("p",[e._v("可以选择 issue 类型：bug、improvement、new feature等。新建的 issue 会自动向邮件列表中同步邮件，之后的讨论可在 jira 上留言，也可以在邮件列表进行。当问题解决后请关闭 issue。")]),e._v(" "),a("h2",{attrs:{id:"邮件讨论内容-英文"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#邮件讨论内容-英文"}},[e._v("#")]),e._v(" 邮件讨论内容（英文）")]),e._v(" "),a("ul",[a("li",[a("p",[e._v("第一次参与邮件列表可以简单介绍一下自己。（Hi, I'm xxx ...)")])]),e._v(" "),a("li",[a("p",[e._v("开发功能前可以发邮件声明一下自己想做的任务。（Hi，I'm working on issue IOTDB-XXX，My plan is ...）")])])]),e._v(" "),a("h2",{attrs:{id:"贡献文档"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#贡献文档"}},[e._v("#")]),e._v(" 贡献文档")]),e._v(" "),a("p",[e._v("IoTDB 所有官网上的内容都在项目根目录的 docs 中：")]),e._v(" "),a("ul",[a("li",[e._v("docs/SystemDesign: 系统设计文档-英文版")]),e._v(" "),a("li",[e._v("docs/zh/SystemDesign: 系统设计文档-中文版")]),e._v(" "),a("li",[e._v("docs/UserGuide: 用户手册-英文版")]),e._v(" "),a("li",[e._v("docs/zh/UserGuide: 用户手册-中文版")]),e._v(" "),a("li",[e._v("docs/Community: 社区-英文版")]),e._v(" "),a("li",[e._v("docs/zh/Community: 社区-中文版")]),e._v(" "),a("li",[e._v("docs/Development: 开发指南-英文版")]),e._v(" "),a("li",[e._v("docs/zh/Development: 开发指南-中文版")])]),e._v(" "),a("p",[e._v("官网上的版本和分支的对应关系：")]),e._v(" "),a("ul",[a("li",[e._v("In progress -> master")]),e._v(" "),a("li",[e._v("major_version.x -> rel/major_version （如 0.9.x -> rel/0.9）")])]),e._v(" "),a("p",[e._v("注意事项：")]),e._v(" "),a("ul",[a("li",[e._v("Markdown 中的图片可上传至 https://github.com/thulab/iotdb/issues/543 获得 url")])]),e._v(" "),a("h2",{attrs:{id:"代码格式化"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#代码格式化"}},[e._v("#")]),e._v(" 代码格式化")]),e._v(" "),a("p",[e._v("我们使用 "),a("a",{attrs:{href:"https://github.com/diffplug/spotless/tree/main/plugin-maven",target:"_blank",rel:"noopener noreferrer"}},[e._v("Spotless\nplugin"),a("OutboundLink")],1),e._v(" 和 "),a("a",{attrs:{href:"https://github.com/google/google-java-format",target:"_blank",rel:"noopener noreferrer"}},[e._v("google-java-format"),a("OutboundLink")],1),e._v(" 格式化Java代码. 你可以通过以下步骤将IDE配置为在保存时自动应用格式以IDEA为例)：")]),e._v(" "),a("ol",[a("li",[e._v("下载 "),a("a",{attrs:{href:"https://plugins.jetbrains.com/plugin/8527-google-java-format/versions/stable/83169",target:"_blank",rel:"noopener noreferrer"}},[e._v("google-java-format-plugin v1.7.0.5"),a("OutboundLink")],1),e._v(", 安装到IDEA(Preferences -> plugins -> search google-java-format),"),a("a",{attrs:{href:"https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides",target:"_blank",rel:"noopener noreferrer"}},[e._v("更详细的操作手册"),a("OutboundLink")],1)]),e._v(" "),a("li",[e._v('从磁盘安装 (Plugins -> little gear icon -> "Install plugin from disk" -> Navigate to downloaded zip file)')]),e._v(" "),a("li",[e._v("开启插件，并保持默认的GOOGLE格式 (2-space indents)")]),e._v(" "),a("li",[e._v("在Spotless没有升级到18+之前,不要升级google-java-format插件")]),e._v(" "),a("li",[e._v("安装 "),a("a",{attrs:{href:"https://plugins.jetbrains.com/plugin/7642-save-actions",target:"_blank",rel:"noopener noreferrer"}},[e._v("Save Actions 插件"),a("OutboundLink")],1),e._v(' , 并开启插件, 打开 "Optimize imports" and "Reformat file" 选项.')]),e._v(" "),a("li",[e._v('在“Save Actions”设置页面中，将 "File Path Inclusion" 设置为.*.java”, 避免在编辑的其他文件时候发生意外的重新格式化')])]),e._v(" "),a("h2",{attrs:{id:"贡献代码"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#贡献代码"}},[e._v("#")]),e._v(" 贡献代码")]),e._v(" "),a("p",[e._v("可以到 jira 上领取现有 issue 或者自己创建 issue 再领取，评论说我要做这个 issue 就可以。")]),e._v(" "),a("ul",[a("li",[e._v("克隆仓库到自己的本地的仓库，clone到本地，关联apache仓库为上游 upstream 仓库。")]),e._v(" "),a("li",[e._v("从 master 切出新的分支，分支名根据这个分支的功能决定，一般叫 f_new_feature(如f_storage_engine) 或者 fix_bug(如fix_query_cache_bug)")]),e._v(" "),a("li",[e._v("在 idea 中添加code style为 根目录的 java-google-style.xml")]),e._v(" "),a("li",[e._v("修改代码，增加测试用例（单元测试、集成测试）\n"),a("ul",[a("li",[e._v("集成测试参考: server/src/test/java/org/apache/iotdb/db/integration/IoTDBTimeZoneIT")])])]),e._v(" "),a("li",[e._v("用 "),a("code",[e._v("mvn spotless:check")]),e._v(" 检查代码样式，并用"),a("code",[e._v("mvn spotless:apply")]),e._v("修复样式")]),e._v(" "),a("li",[e._v("提交 PR, 以 [IOTDB-jira号] 开头")]),e._v(" "),a("li",[e._v("发邮件到 dev 邮件列表：(I've submitted a PR for issue IOTDB-xxx [link])")]),e._v(" "),a("li",[e._v("根据其他人的审阅意见进行修改，继续更新，直到合并")]),e._v(" "),a("li",[e._v("关闭 jira issue")])]),e._v(" "),a("h1",{attrs:{id:"二、iotdb-调试方式"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#二、iotdb-调试方式"}},[e._v("#")]),e._v(" 二、IoTDB 调试方式")]),e._v(" "),a("h2",{attrs:{id:"导入代码"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#导入代码"}},[e._v("#")]),e._v(" 导入代码")]),e._v(" "),a("h3",{attrs:{id:"intellij-idea"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#intellij-idea"}},[e._v("#")]),e._v(" Intellij idea")]),e._v(" "),a("p",[e._v("推荐使用 Intellij idea。"),a("code",[e._v("mvn clean package -DskipTests")])]),e._v(" "),a("p",[e._v("之后把 "),a("code",[e._v("antlr/target/generated-sources/antlr4")]),e._v(" 和 "),a("code",[e._v("thrift/target/generated-sources/thrift")]),e._v(" 标记为 "),a("code",[e._v("Source Root")]),e._v("。")]),e._v(" "),a("h3",{attrs:{id:"eclipse"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#eclipse"}},[e._v("#")]),e._v(" Eclipse")]),e._v(" "),a("p",[e._v("如果是 eclipse 2019 之前的版本，需要现在 IoTDB 根目录执行 "),a("code",[e._v("mvn eclipse:eclipse -DskipTests")]),e._v("。")]),e._v(" "),a("p",[e._v("import -> General -> Existing Projects into Workspace -> 选择 IoTDB 根目录")]),e._v(" "),a("p",[e._v("如果 eclipse 2019 之后的版本")]),e._v(" "),a("p",[e._v("import -> Maven -> Existing Maven Projects")]),e._v(" "),a("h2",{attrs:{id:"调试代码"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#调试代码"}},[e._v("#")]),e._v(" 调试代码")]),e._v(" "),a("ul",[a("li",[a("p",[e._v("服务器主函数："),a("code",[e._v("server/src/main/java/org/apache/iotdb/db/service/IoTDB")]),e._v("，可以debug模式启动")])]),e._v(" "),a("li",[a("p",[e._v("命令行界面："),a("code",[e._v("cli/src/main/java/org/apache/iotdb/cli/")]),e._v('，linux 用 Cli，windows 用 WinCli，可以直接启动。启动时需要参数"-h 127.0.0.1 -p 6667 -u root -pw root"')])]),e._v(" "),a("li",[a("p",[e._v("服务器的 rpc 实现（主要用来客户端和服务器通信，一般在这里开始打断点）："),a("code",[e._v("server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl")])]),e._v(" "),a("ul",[a("li",[e._v("jdbc所有语句：executeStatement(TSExecuteStatementReq req)")]),e._v(" "),a("li",[e._v("jdbc查询语句：executeQueryStatement(TSExecuteStatementReq req)")]),e._v(" "),a("li",[e._v("native写入接口：insertRecord(TSInsertRecordReq req)")])])]),e._v(" "),a("li",[a("p",[e._v("存储引擎 org.apache.iotdb.db.engine.StorageEngine")])]),e._v(" "),a("li",[a("p",[e._v("查询引擎 org.apache.iotdb.db.qp.Planner")])])]),e._v(" "),a("h2",{attrs:{id:"常见编译错误"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#常见编译错误"}},[e._v("#")]),e._v(" 常见编译错误")]),e._v(" "),a("ol",[a("li",[e._v("无法下载 thrift-* 等文件, 例如 "),a("code",[e._v("Could not get content org.apache.maven.wagon.TransferFailedException: Transfer failed for https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_linux.exe")])])]),e._v(" "),a("p",[e._v("这一般是网络问题，这时候需要手动下载上述文件：")]),e._v(" "),a("ul",[a("li",[e._v("根据以下网址手动下载上述文件;\n"),a("ul",[a("li",[e._v("https://github.com/jt2594838/mvn-thrift-compiler/blob/master/thrift_0.12.0_0.13.0_mac.exe")]),e._v(" "),a("li",[e._v("https://github.com/jt2594838/mvn-thrift-compiler/raw/master/thrift_0.12.0_0.13.0_mac.exe")])])]),e._v(" "),a("li",[e._v("将该文件拷贝到thrift/target/tools/目录下")]),e._v(" "),a("li",[e._v("重新执行maven的编译命令")])])])}),[],!1,null,null,null);t.default=r.exports}}]);