This is an automated email from the ASF dual-hosted git repository. qiaojialin pushed a commit to branch fix_contribut_doc in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
commit 184a669d92f7222995294409e192234066e31451 Author: qiaojialin <[email protected]> AuthorDate: Mon Dec 30 16:08:47 2019 +0800 update develop-chinese --- docs/Development-Chinese.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/Development-Chinese.md b/docs/Development-Chinese.md index 8e3ed5c..e56ae68 100644 --- a/docs/Development-Chinese.md +++ b/docs/Development-Chinese.md @@ -37,41 +37,42 @@ IoTDB 官网：https://iotdb.apache.org/ 关注方法：用想接收邮件的邮箱向 [email protected] 发一封邮件，主题内容不限，收到回复后，再次向确认地址发一封确认邮件（确认地址比较长，推荐qq邮箱）。 -## 新功能、Bug 反馈、改进等目标记录 +## 新功能、Bug 反馈、改进等 -在 Jira 上提 issue：https://issues.apache.org/jira/projects/IOTDB/issues/IOTDB-9?filter=allopenissues +所有希望 IoTDB 做的功能或修的 bug，都可以在 Jira 上提 issue：https://issues.apache.org/jira/projects/IOTDB/issues/IOTDB-9?filter=allopenissues -选择 issue 类型：bug、improvement、new feature等。新建的 issue 会自动向邮件列表中同步邮件，之后的讨论可在 jira 上留言，也可以在邮件列表进行。当问题解决后请关闭 issue。 +可以选择 issue 类型：bug、improvement、new feature等。新建的 issue 会自动向邮件列表中同步邮件，之后的讨论可在 jira 上留言，也可以在邮件列表进行。当问题解决后请关闭 issue。 ## 邮件讨论内容（英文） -* 初来乍到：大家好，我是xxx，新加入 IoTDB 社区，希望。 +* 第一个参与邮件列表可以简单介绍一下自己。（Hi, I'm xxx ...) -* 小试牛刀：Hi，我正在解决这个 issue，给个链接，我预计的解决方案是xxx。 +* 开发功能前可以发邮件声明一下自己想做的任务。（Hi，I'm working on issue IOTDB-XXX，My plan is ...） ## 贡献代码 -可以去 jira 上领取现有 issue 或者自己创建 issue 再领取，评论说我要做这个 issue 就可以。 +可以到 jira 上领取现有 issue 或者自己创建 issue 再领取，评论说我要做这个 issue 就可以。 * 克隆仓库到自己的本地的仓库，clone到本地，关联apache仓库为上游 upstream 仓库。 -* 从 master 切出新的分支，分支名根据这个分支的功能决定，一般叫 f_【新功能】 或者 fix_【bug】 +* 从 master 切出新的分支，分支名根据这个分支的功能决定，一般叫 f_new_feature(如f_storage_engine) 或者 fix_bug(如fix_query_cache_bug) * 在 idea 中添加code style为 根目录的 java-google-style.xml * 修改代码，增加测试用例（单元测试、集成测试） * 集成测试参考: server/src/test/java/org/apache/iotdb/db/integration/IoTDBTimeZoneIT * 提交 PR, 以 [IOTDB-jira号] 开头 -* dev发邮件：我已经提交PR，附上pr链接 +* 发邮件到 dev 邮件列表：(I've submitted a PR for issue IOTDB-xxx [link]) * 根据其他人的审阅意见进行修改，继续更新，直到合并 * 关闭 jira issue ## 二、IoTDB 调试方式 -* 服务器主函数：server/src/main/java/org/apache/iotdb/db/service/IoTDB，可以debug启动 -* 客户端：client/src/main/java/org/apache/iotdb/client，linux 用 Clinet，windows 用WinClint，可以直接启动，需要参数"-h 127.0.0.1 -p 6667 -u root -pw root" -* 服务器的 rpc 实现（主要用来客户端和服务器通信，一般在这里开始打断点）：server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl +推荐使用 Intellij idea。```mvn clean package -DskipTests``` 之后把 ```server/target/generated-sources/antlr4``` 和 ```service-rpc/target/generated-sources/thrift``` 标记为 ```Source Root```。 + +* 服务器主函数：```server/src/main/java/org/apache/iotdb/db/service/IoTDB```，可以debug模式启动 +* 客户端：```client/src/main/java/org/apache/iotdb/client/```，linux 用 Clinet，windows 用 WinClint，可以直接启动，需要参数"-h 127.0.0.1 -p 6667 -u root -pw root" +* 服务器的 rpc 实现（主要用来客户端和服务器通信，一般在这里开始打断点）：```server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl``` * jdbc所有语句：executeStatement(TSExecuteStatementReq req) * jdbc查询语句：executeQueryStatement(TSExecuteStatementReq req) * native写入接口：insert(TSInsertReq req) - -* 写入引擎 org.apache.iotdb.db.engine.StorageEngine +* 存储引擎 org.apache.iotdb.db.engine.StorageEngine * 查询引擎 org.apache.iotdb.db.qp.QueryProcessor
