You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2021/05/14 08:27:53 UTC
[iotdb] 02/02: Update ContributeGuide
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch rdm
in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit 8bf70fc3868c21ba293a50206fbfc40d5b76db41
Author: HTHou <hh...@outlook.com>
AuthorDate: Fri May 14 16:27:20 2021 +0800
Update ContributeGuide
---
.../ContributeGuide.md => CONTRIBUTING.md | 44 ++++++++++++----------
docs/Development/ContributeGuide.md | 44 ++++++++++++----------
docs/zh/Development/ContributeGuide.md | 10 ++---
3 files changed, 55 insertions(+), 43 deletions(-)
diff --git a/docs/Development/ContributeGuide.md b/CONTRIBUTING.md
similarity index 80%
copy from docs/Development/ContributeGuide.md
copy to CONTRIBUTING.md
index 3dea6c0..7bb0fd3 100644
--- a/docs/Development/ContributeGuide.md
+++ b/CONTRIBUTING.md
@@ -19,7 +19,7 @@
-->
-# 1. work process
+# IoTDB Working Process
## Main link
@@ -47,17 +47,17 @@ Other mailing list:
-## New features, bug feedback, improvements, and more
+## New features, bug feedback, improvements and more
All features or bugs that you want IoTDB to do can be raised on Jira：https://issues.apache.org/jira/projects/IOTDB/issues
-You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
+You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
## Email discussion content (English)
-* Joining the mailing list for the first time can introduce you briefly. (Hi, I'm xxx ...)
+* Joining the mailing list for the first time can introduce youself briefly. (Hi, I'm xxx ...)
-* Before developing a function, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
+* Before developing a new feature, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
## Contributing documents
@@ -75,15 +75,15 @@ The content of all IoTDB official websites is in the docs of the project root di
Correspondence between versions and branches on the official website:
* In progress -> master
-* major_version.x -> rel/major_version （如 0.9.x -> rel/0.9）
+* major_version.x -> rel/major_version （eg 0.9.x -> rel/0.9）
Precautions:
-* Images in Markdown can be uploaded to https://github.com/thulab/iotdb/issues/543 for url
+* Images in Markdown can be uploaded to https://github.com/apache/iotdb-bin-resources for url
* Do not use special Unicode chars, e.g., U+FF1A
* Do not use the character of dollar (as we will use Latex to generate pdf files)
-### Code Formatting
+## Code Formatting
We use the [Spotless
plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together with [google-java-format](https://github.com/google/google-java-format) to format our Java code. You can configure your IDE to automatically apply formatting on saving with these steps(Take idea as an example):
@@ -123,22 +123,28 @@ You can go to jira to pick up the existing issue or create your own issue and ge
* Make changes based on other people's reviews and continue to update until merged
* close jira issue
-## 2. IoTDB debugging method
+# IoTDB Debug Guide
-Recommended Use Intellij idea. ```mvn clean package -DskipTests``` After putting ```antlr/target/generated-sources/antlr4``` and ```thrift/target/generated-sources/thrift``` marked as ```Source Root```。
+Recommended use Intellij idea.
+```
+mvn clean package -DskipTests
+```
+
+Mark `antlr/target/generated-sources/antlr4` and `thrift/target/generated-sources/thrift` as `Source Root`.
-* Server main function：```server/src/main/java/org/apache/iotdb/db/service/IoTDB``, Can be started in debug mode
-* Cli：```cli/src/main/java/org/apache/iotdb/cli/```，Use Cli for linux and WinCli for windows, you can start directly with the parameter "-h 127.0.0.1 -p 6667 -u root -pw root"
-* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):```server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl```
- * all jdbc statements：executeStatement(TSExecuteStatementReq req)
- * jdbc query：executeQueryStatement(TSExecuteStatementReq req)
- * native Write interface：insertRecord(TSInsertRecordReq req)
+* Server main function：`server/src/main/java/org/apache/iotdb/db/service/IoTDB`, can be started in debug mode.
+* Cli：`cli/src/main/java/org/apache/iotdb/cli/`，Use Cli for linux and WinCli for windows, you can start directly with the parameter "`-h 127.0.0.1 -p 6667 -u root -pw root`"
+* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):`server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl`
+* all jdbc statements：`executeStatement(TSExecuteStatementReq req)`
+* jdbc query：`executeQueryStatement(TSExecuteStatementReq req)`
+* native Write interface：`insertRecord(TSInsertRecordReq req)`
+`insertTablet(TSInsertTabletReq req)`
-* Storage engine org.apache.iotdb.db.engine.StorageEngine
-* Query engine org.apache.iotdb.db.qp.QueryProcessor
+* Storage engine`org.apache.iotdb.db.engine.StorageEngine`
+* Query engine `org.apache.iotdb.db.qp.QueryProcessor`
-## Frequent Questions when Compiling the Source Code
+# Frequent Questions when Compiling the Source Code
1. I could not download thrift-* tools, like `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`
diff --git a/docs/Development/ContributeGuide.md b/docs/Development/ContributeGuide.md
index 3dea6c0..7bb0fd3 100644
--- a/docs/Development/ContributeGuide.md
+++ b/docs/Development/ContributeGuide.md
@@ -19,7 +19,7 @@
-->
-# 1. work process
+# IoTDB Working Process
## Main link
@@ -47,17 +47,17 @@ Other mailing list:
-## New features, bug feedback, improvements, and more
+## New features, bug feedback, improvements and more
All features or bugs that you want IoTDB to do can be raised on Jira：https://issues.apache.org/jira/projects/IOTDB/issues
-You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
+You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue.
## Email discussion content (English)
-* Joining the mailing list for the first time can introduce you briefly. (Hi, I'm xxx ...)
+* Joining the mailing list for the first time can introduce youself briefly. (Hi, I'm xxx ...)
-* Before developing a function, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
+* Before developing a new feature, you can send an e-mail to declare the task you want to do.（Hi，I'm working on issue IOTDB-XXX，My plan is ...）
## Contributing documents
@@ -75,15 +75,15 @@ The content of all IoTDB official websites is in the docs of the project root di
Correspondence between versions and branches on the official website:
* In progress -> master
-* major_version.x -> rel/major_version （如 0.9.x -> rel/0.9）
+* major_version.x -> rel/major_version （eg 0.9.x -> rel/0.9）
Precautions:
-* Images in Markdown can be uploaded to https://github.com/thulab/iotdb/issues/543 for url
+* Images in Markdown can be uploaded to https://github.com/apache/iotdb-bin-resources for url
* Do not use special Unicode chars, e.g., U+FF1A
* Do not use the character of dollar (as we will use Latex to generate pdf files)
-### Code Formatting
+## Code Formatting
We use the [Spotless
plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together with [google-java-format](https://github.com/google/google-java-format) to format our Java code. You can configure your IDE to automatically apply formatting on saving with these steps(Take idea as an example):
@@ -123,22 +123,28 @@ You can go to jira to pick up the existing issue or create your own issue and ge
* Make changes based on other people's reviews and continue to update until merged
* close jira issue
-## 2. IoTDB debugging method
+# IoTDB Debug Guide
-Recommended Use Intellij idea. ```mvn clean package -DskipTests``` After putting ```antlr/target/generated-sources/antlr4``` and ```thrift/target/generated-sources/thrift``` marked as ```Source Root```。
+Recommended use Intellij idea.
+```
+mvn clean package -DskipTests
+```
+
+Mark `antlr/target/generated-sources/antlr4` and `thrift/target/generated-sources/thrift` as `Source Root`.
-* Server main function：```server/src/main/java/org/apache/iotdb/db/service/IoTDB``, Can be started in debug mode
-* Cli：```cli/src/main/java/org/apache/iotdb/cli/```，Use Cli for linux and WinCli for windows, you can start directly with the parameter "-h 127.0.0.1 -p 6667 -u root -pw root"
-* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):```server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl```
- * all jdbc statements：executeStatement(TSExecuteStatementReq req)
- * jdbc query：executeQueryStatement(TSExecuteStatementReq req)
- * native Write interface：insertRecord(TSInsertRecordReq req)
+* Server main function：`server/src/main/java/org/apache/iotdb/db/service/IoTDB`, can be started in debug mode.
+* Cli：`cli/src/main/java/org/apache/iotdb/cli/`，Use Cli for linux and WinCli for windows, you can start directly with the parameter "`-h 127.0.0.1 -p 6667 -u root -pw root`"
+* Server rpc implementation (mainly used for cli and server communication, generally start interruption point here):`server/src/main/java/org/apache/iotdb/db/service/TSServiceImpl`
+* all jdbc statements：`executeStatement(TSExecuteStatementReq req)`
+* jdbc query：`executeQueryStatement(TSExecuteStatementReq req)`
+* native Write interface：`insertRecord(TSInsertRecordReq req)`
+`insertTablet(TSInsertTabletReq req)`
-* Storage engine org.apache.iotdb.db.engine.StorageEngine
-* Query engine org.apache.iotdb.db.qp.QueryProcessor
+* Storage engine`org.apache.iotdb.db.engine.StorageEngine`
+* Query engine `org.apache.iotdb.db.qp.QueryProcessor`
-## Frequent Questions when Compiling the Source Code
+# Frequent Questions when Compiling the Source Code
1. I could not download thrift-* tools, like `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`
diff --git a/docs/zh/Development/ContributeGuide.md b/docs/zh/Development/ContributeGuide.md
index 930b3d8..c4997d8 100644
--- a/docs/zh/Development/ContributeGuide.md
+++ b/docs/zh/Development/ContributeGuide.md
@@ -19,7 +19,7 @@
-->
-# 一、工作流程
+# 工作流程
## 主要链接
@@ -47,7 +47,7 @@ Wiki 文档管理：https://cwiki.apache.org/confluence/display/IOTDB/Home
* commits@iotdb.apache.org (任何代码改动都会通知到此处。该邮件列表邮件数量十分多，请注意。)
* reviews@iotdb.apache.org (任何代码审阅意见都会通知到此处。该邮件列表邮件数量十分多，请注意。)
-## 新功能、Bug 反馈、改进等
+## 新功能、Bug反馈、改进等
所有希望 IoTDB 做的功能或修的 bug，都可以在 Jira 上提 issue
@@ -79,7 +79,7 @@ IoTDB 所有官网上的内容都在项目根目录的 docs 中：
注意事项：
-* Markdown 中的图片可上传至 https://github.com/thulab/iotdb/issues/543 获得 url
+* Markdown 中的图片可上传至 https://github.com/apache/iotdb-bin-resources 获得 url
## 代码格式化
@@ -108,7 +108,7 @@ plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) 和 [google
* 根据其他人的审阅意见进行修改，继续更新，直到合并
* 关闭 jira issue
-# 二、IoTDB 调试方式
+# IoTDB调试方式
## 导入代码
@@ -142,7 +142,7 @@ import -> Maven -> Existing Maven Projects
-## 常见编译错误
+# 常见编译错误
1. 无法下载 thrift-* 等文件, 例如 `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`