This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 511d5f4 Update ContributeGuide.md (#3611)
511d5f4 is described below
commit 511d5f4ff576fa72b96d2f7018dc037276e7c19c
Author: zhengjp31 <[email protected]>
AuthorDate: Fri Jul 23 18:59:06 2021 +0800
Update ContributeGuide.md (#3611)
---
docs/Development/ContributeGuide.md | 37 +++++++++++++++++++++++++++----------
1 file changed, 27 insertions(+), 10 deletions(-)
diff --git a/docs/Development/ContributeGuide.md
b/docs/Development/ContributeGuide.md
index fd4a5ce..14512cf 100644
--- a/docs/Development/ContributeGuide.md
+++ b/docs/Development/ContributeGuide.md
@@ -29,6 +29,10 @@ Code library：https://github.com/apache/iotdb/tree/master
Get started
quickly：http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html
+Jira Task Management：https://issues.apache.org/jira/projects/IOTDB/issues
+
+Wiki Document
Management：https://cwiki.apache.org/confluence/display/IOTDB/Home\
+
## Subscribe to mailing list
The mailing list is where the Apache project conducts technical discussions
and communication with users. Follow the mailing list to receive mail.
@@ -40,10 +44,9 @@ Follow method: Send an email to
[email protected] with the email yo
Other mailing list:
* [email protected] (for JIRA information notification.)
- * If you just want to pay attention to some issues, you do not need to
subscribe this mailing list.
- Instead, you just need to click "start-watching this issue" on the jira
issue webpage.
-* [email protected] (for code changes notification. Take care because
this mailing list may have many emails)
-* [email protected] (for code reviews notification on Github. Take
care because this mailing list may have many emails)
+ * If you only want to receive individual Jira notifications that you are
interest in, you do not need to subscribe this mailing list. Instead, you just
need to click "start-watching this issue" on the jira issue webpage or just
comment on this issue.
+* [email protected] (Any code changes will be notified here, please
note that this mailing list will be very large)
+* [email protected] (Any code review comments will be notified here,
please note that this mailing list will be very large)
@@ -125,12 +128,26 @@ You can go to jira to pick up the existing issue or
create your own issue and ge
# IoTDB Debug Guide
-Recommended use Intellij idea.
-```
-mvn clean package -DskipTests
-```
+## Import the code
+
+### Intellij idea
+
+It is recommended to use Intellij idea。```mvn clean package -DskipTests```
+
+Mark ```antlr/target/generated-sources/antlr4```
and```thrift/target/generated-sources/thrift``` as ```Source Root```。
+
+### Eclipse
+
+If it is a version before eclipse 2019，users need to be executed in the root
directory of IoTDB `mvn eclipse:eclipse -DskipTests`。
+
+import -> General -> Existing Projects into Workspace -> Select IoTDB root
directory
+
+If the version after eclipse 2019
+
+import -> Maven -> Existing Maven Projects
+
+## Debugging code
-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`"
@@ -158,4 +175,4 @@ org.apache.maven.wagon.TransferFailedException: Transfer
failed for https://gith
* Put the file to thrift/target/tools/
- * Re-run maven command like `mvn compile`
\ No newline at end of file
+ * Re-run maven command like `mvn compile`
