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/09/25 04:53:02 UTC
[iotdb] branch master updated: Improve ContributeGuide.md and
HowToCommit.md (#4030)
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 8ce16e9 Improve ContributeGuide.md and HowToCommit.md (#4030)
8ce16e9 is described below
commit 8ce16e9db08584974e028bf6d30c3bba8b8751c8
Author: JYBSD <81...@users.noreply.github.com>
AuthorDate: Sat Sep 25 12:52:25 2021 +0800
Improve ContributeGuide.md and HowToCommit.md (#4030)
Co-authored-by: liutong <61...@qq.com>
---
docs/Development/ContributeGuide.md | 12 +++++++++++-
docs/Development/HowToCommit.md | 18 ++++++++++++++++++
docs/zh/Development/ContributeGuide.md | 10 ++++++++++
docs/zh/Development/HowToCommit.md | 18 ++++++++++++++++++
4 files changed, 57 insertions(+), 1 deletion(-)
diff --git a/docs/Development/ContributeGuide.md b/docs/Development/ContributeGuide.md
index 14512cf..b5133fe 100644
--- a/docs/Development/ContributeGuide.md
+++ b/docs/Development/ContributeGuide.md
@@ -25,7 +25,11 @@
IoTDB official website：https://iotdb.apache.org/
-Code library：https://github.com/apache/iotdb/tree/master
+Code library：https://github.com/apache/iotdb
+
+Code library for go language: https://github.com/apache/iotdb-client-go
+
+Library for resources (project's documents, compiler, etc): https://github.com/apache/iotdb-bin-resources
Get started quickly：http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html
@@ -33,6 +37,12 @@ Jira Task Management：https://issues.apache.org/jira/projects/IOTDB/issues
Wiki Document Management：https://cwiki.apache.org/confluence/display/IOTDB/Home\
+Mailing list: https://lists.apache.org/list.html?dev@iotdb.apache.org
+
+Everyday build: https://ci-builds.apache.org/job/IoTDB/job/IoTDB-Pipe/job/master/
+
+Slack: https://apacheiotdb.slack.com/join/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg#/shared-invite/email
+
## 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.
diff --git a/docs/Development/HowToCommit.md b/docs/Development/HowToCommit.md
index 96bbf35..e6378fb 100644
--- a/docs/Development/HowToCommit.md
+++ b/docs/Development/HowToCommit.md
@@ -85,6 +85,24 @@ git push origin fix
For more on git usages, please visit[Git tutorial](https://www.atlassian.com/git/tutorials/setting-up-a-repository).
+### Submission Considerations
+
+When submitting code on git, you should pay attention to:
+
+- Keep the repository clean:
+
+ - Do not submit binary files, so that the size of the repository only increases due to changes in the code.
+
+ - Do not submit generated code.
+
+- The log should have meaning:
+
+ - Title is jira numbered: [IOTDB-jira number]
+
+ - Title is the issue number of GitHub: [ISSUE-issue number]
+
+ - Write #XXXX in the content for association.
+
### Create PR
Goto your github page, find the apache/servicecomb-website project, swich to the branch you just pushed, click on `New pull request` and then `Create pull request`, see the image below:If you solve the [issues](https://issues.apache.org/jira/projects/IOTDB/issues), you need to add [IOTDB-xxx] at the beginning，see the image below:
diff --git a/docs/zh/Development/ContributeGuide.md b/docs/zh/Development/ContributeGuide.md
index 5f00eee..22b522b 100644
--- a/docs/zh/Development/ContributeGuide.md
+++ b/docs/zh/Development/ContributeGuide.md
@@ -27,12 +27,22 @@ IoTDB 官网：https://iotdb.apache.org/
代码库：https://github.com/apache/iotdb/tree/master
+Go语言的代码库：https://github.com/apache/iotdb-client-go
+
+资源库（包含项目文件等）：https://github.com/apache/iotdb-bin-resources
+
快速上手：http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html
Jira 任务管理：https://issues.apache.org/jira/projects/IOTDB/issues
Wiki 文档管理：https://cwiki.apache.org/confluence/display/IOTDB/Home
+邮件列表: https://lists.apache.org/list.html?dev@iotdb.apache.org
+
+每日构建: https://ci-builds.apache.org/job/IoTDB/job/IoTDB-Pipe/job/master/
+
+Slack: https://apacheiotdb.slack.com/join/shared_invite/zt-qvso1nj8-7715TpySZtZqmyG5qXQwpg#/shared-invite/email
+
## 订阅邮件列表
邮件列表是 Apache 项目进行技术讨论和用户沟通的地方，订阅邮件列表就可以收到邮件了。
diff --git a/docs/zh/Development/HowToCommit.md b/docs/zh/Development/HowToCommit.md
index f47a8e7..82bcbd8 100644
--- a/docs/zh/Development/HowToCommit.md
+++ b/docs/zh/Development/HowToCommit.md
@@ -85,6 +85,24 @@ git push origin fix
更多 git 使用方法请访问：[git 使用](https://www.atlassian.com/git/tutorials/setting-up-a-repository)，这里不赘述。
+### Git提交注意事项
+
+在Git上提交代码时需要注意：
+
+- 保持仓库的整洁：
+
+ - 不要上传二进制文件，保证仓库的大小只因为代码字符串的改动而增大。
+
+ - 不要上传生成的代码。
+
+- 日志要有含义：
+
+ - 题目用jira编号：[IOTDB-jira号]
+
+ - 题目用github的ISSUE编号：[ISSUE-issue号]
+
+ - 内容里要写#XXXX用于关联
+
### 创建 PR
在浏览器切换到自己的 github 仓库页面，切换分支到提交的分支 <your_branch_name> ，依次点击 `New pull request` 和 `Create pull request` 按钮进行创建，如果您解决的是 [issues](https://issues.apache.org/jira/projects/IOTDB/issues)，需要在开头加上 [IOTDB-xxx]，如下图所示：