You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by mo...@apache.org on 2022/05/05 12:46:07 UTC
[incubator-doris] branch master updated: [doc][community] add more collaborator and modify documents (#9320)
This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris.git
The following commit(s) were added to refs/heads/master by this push:
new cec09c18f9 [doc][community] add more collaborator and modify documents (#9320)
cec09c18f9 is described below
commit cec09c18f979b11715af60cf54e5d4cf3159bfeb
Author: Mingyu Chen <mo...@gmail.com>
AuthorDate: Thu May 5 20:46:03 2022 +0800
[doc][community] add more collaborator and modify documents (#9320)
1. Add collaborator morrySnow
2. Add document: How To Be A Committer
3. Add guidance to install clang-format 11
---
.asf.yaml | 1 +
docs/.vuepress/sidebar/en.js | 3 +-
docs/.vuepress/sidebar/zh-CN.js | 3 +-
.../{committer-guide.md => contributor-guide.md} | 12 +++----
.../how-to-contribute/how-to-be-a-committer.md | 37 ++++++++++++++++++++++
docs/en/developer-guide/cpp-format-code.md | 4 +++
.../{committer-guide.md => contributor-guide.md} | 12 +++----
.../how-to-contribute/how-to-be-a-committer.md | 37 ++++++++++++++++++++++
docs/zh-CN/developer-guide/cpp-format-code.md | 4 +++
9 files changed, 99 insertions(+), 14 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index f520995cb6..8f933fdc49 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -55,3 +55,4 @@ github:
- zuochunwei
- thomascai126
- dataroaring
+ - morrySnow
diff --git a/docs/.vuepress/sidebar/en.js b/docs/.vuepress/sidebar/en.js
index 0170060b47..f073b098b9 100644
--- a/docs/.vuepress/sidebar/en.js
+++ b/docs/.vuepress/sidebar/en.js
@@ -1020,7 +1020,8 @@ module.exports = [
initialOpenGroupIndex: -1,
children: [
"how-to-contribute",
- "committer-guide",
+ "contributor-guide",
+ "how-to-be-a-committer",
"commit-format-specification",
"pull-request",
],
diff --git a/docs/.vuepress/sidebar/zh-CN.js b/docs/.vuepress/sidebar/zh-CN.js
index 365f41e9c5..73aa561caf 100644
--- a/docs/.vuepress/sidebar/zh-CN.js
+++ b/docs/.vuepress/sidebar/zh-CN.js
@@ -1022,7 +1022,8 @@ module.exports = [
initialOpenGroupIndex: -1,
children: [
"how-to-contribute",
- "committer-guide",
+ "contributor-guide",
+ "how-to-be-a-committer",
"commit-format-specification",
"pull-request",
],
diff --git a/docs/en/community/how-to-contribute/committer-guide.md b/docs/en/community/how-to-contribute/contributor-guide.md
similarity index 91%
rename from docs/en/community/how-to-contribute/committer-guide.md
rename to docs/en/community/how-to-contribute/contributor-guide.md
index 377db00876..dfb700f11c 100644
--- a/docs/en/community/how-to-contribute/committer-guide.md
+++ b/docs/en/community/how-to-contribute/contributor-guide.md
@@ -1,6 +1,6 @@
---
{
- "title": "Committer Guide",
+ "title": "Contributor Guide",
"language": "en"
}
---
@@ -24,9 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-# Committer Guide
+# Contributor Guide
-## New Committer Guidelines
+## New Contributor Guidelines
### Subscribe to the public mailing lists
@@ -66,11 +66,11 @@ and you will be able to manage issues and pull request directly through our Gith
## Pull Request Guidelines
-1. During a PR, there are three types of roles. Contributor: the PR submitter; Reviewer: the person who needs to make code-level review on the PR; and Moderator: the person responsible for coordinating the entire PR process. For example, the moderator should assign reviewers, push the author to make changes according to the comments, set different tags for the PR, and merge the PR etc. For a specific PR, a person may act in different roles, such as when a committer submitted one PR, he m [...]
+1. During a PR, there are three types of roles. Contributor: the PR submitter; Reviewer: the person who needs to make code-level review on the PR; and Moderator: the person responsible for coordinating the entire PR process. For example, the moderator should assign reviewers, push the author to make changes according to the comments, set different tags for the PR, and merge the PR etc. For a specific PR, a person may act in different roles, such as when a contributor submitted one PR, he [...]
-2. Committers can assign a PR to itself as a moderator. After assigning it to themselves, the other committer will know that this PR has been in charge.
+2. Contributors can assign a PR to itself as a moderator. After assigning it to themselves, the other contributor will know that this PR has been in charge.
-3. The committer is encouraged to act as a moderator for its own PR.
+3. The contributor is encouraged to act as a moderator for its own PR.
4. The reviewer needs to perform a code-level review, refer Code Review Guidelines
diff --git a/docs/en/community/how-to-contribute/how-to-be-a-committer.md b/docs/en/community/how-to-contribute/how-to-be-a-committer.md
new file mode 100644
index 0000000000..d6f4b2ea9e
--- /dev/null
+++ b/docs/en/community/how-to-contribute/how-to-be-a-committer.md
@@ -0,0 +1,37 @@
+---
+{
+ "title": "How To Be A Committer",
+ "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# How To Be A Committer
+
+In an Apache project, developers have three roles:
+
+1. Contributor: When the developer's code is officially merged into the code, the developer automatically becomes the project's Contributor.
+2. Committer: Committer has permission to merge into the code base. Committers are generally elected by the PMC (Project Management Committee).
+3. PMC Member: a member of the project management committee. Have the right to vote on project decisions (such as version releases, etc.). It is generally elected by the PMC (Project Management Committee) through voting.
+
+Different roles have different rights and obligations. There are no strict conditions on how to become a Committer or PMC Member, you can refer to here for more information:
+
+[Guidance for committer promotion](https://cwiki.apache.org/confluence/display/DORIS/Guidance+for+committer+promotion)
diff --git a/docs/en/developer-guide/cpp-format-code.md b/docs/en/developer-guide/cpp-format-code.md
index 27340be128..9d5e7ca6c7 100644
--- a/docs/en/developer-guide/cpp-format-code.md
+++ b/docs/en/developer-guide/cpp-format-code.md
@@ -50,6 +50,10 @@ You need to download and install clang-format, or you can use the clang-format p
### Download and install clang-format
+It is recommended to use NPM to install clang-format 11 (different versions of clang-format may produce different code formats, it is recommended to use version 11):
+
+`npm install clang-format@1.4.0`
+
Ubuntu: `apt-get install clang-format`
The current version is 10.0, you can also specify the old version, for example: `apt-get install clang-format-9`
diff --git a/docs/zh-CN/community/how-to-contribute/committer-guide.md b/docs/zh-CN/community/how-to-contribute/contributor-guide.md
similarity index 91%
rename from docs/zh-CN/community/how-to-contribute/committer-guide.md
rename to docs/zh-CN/community/how-to-contribute/contributor-guide.md
index 4f17bfe538..b8f3fadce1 100644
--- a/docs/zh-CN/community/how-to-contribute/committer-guide.md
+++ b/docs/zh-CN/community/how-to-contribute/contributor-guide.md
@@ -1,6 +1,6 @@
---
{
- "title": "Committer指南",
+ "title": "Contributor 指南",
"language": "zh-CN"
}
---
@@ -24,9 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-# Committer指南
+# Contributor 指南
-## Committer新人指南
+## Contributor 新人指南
### 订阅公共邮件列表
@@ -68,11 +68,11 @@ commits邮件非常重要，因为所有的GitHub Issue，PR提交都会发往
1. 一个PR合入需要三种角色的参与。Contributor：PR的提交者；Reviewer：对PR进行代码级评论的人；Moderator：PR合入的协调者。
Moderator主要负责给PR设定相关标签，推动相关reviewer进行评论，推动作者对PR进行修改，合入PR等工作。
-在一个具体的PR中，一个人可能充当不同的角色，比如一个Committer自己提交的PR，既是Contributor，又是这个PR的Moderator。
+在一个具体的PR中，一个人可能充当不同的角色，比如一个Contributor 自己提交的PR，既是Contributor，又是这个PR的Moderator。
-2. Committer可以把一个PR分配给自己作为整个PR的moderator，负责后续PR的推动工作。分配给自己之后，其他的Committer就知道这个PR有相关人负责了。
+2. Contributor 可以把一个PR分配给自己作为整个PR的moderator，负责后续PR的推动工作。分配给自己之后，其他的Contributor 就知道这个PR有相关人负责了。
-3. 鼓励Committer作为自己PR的Moderator。
+3. 鼓励Contributor 作为自己PR的Moderator。
4. Reviewer需要进行代码级的review，可以参考Code Review Guideline。
diff --git a/docs/zh-CN/community/how-to-contribute/how-to-be-a-committer.md b/docs/zh-CN/community/how-to-contribute/how-to-be-a-committer.md
new file mode 100644
index 0000000000..acfe9de659
--- /dev/null
+++ b/docs/zh-CN/community/how-to-contribute/how-to-be-a-committer.md
@@ -0,0 +1,37 @@
+---
+{
+ "title": "如何成为 Committer",
+ "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 如何成为 Committer
+
+在 Apache 项目中，开发者有三种角色：
+
+1. Contributor：当开发者的代码正式合入代码后，该开发这自动成为该项目的 Contributor。
+2. Committer：Committer 对代码库有合入权限。Committer 一般由 PMC（项目管理委员会）经过投票推举产生。
+3. PMC Member：项目管理委员会成员。对项目的决策（如版本发布等）有投票权。一般由 PMC（项目管理委员会）经过投票推举产生。
+
+不同的角色拥有不同的权利和义务。如何成为 Committer 或 PMC Member 并没有严格的条件，你可以参考这里了解更多信息：
+
+[Guidance for committer promotion](https://cwiki.apache.org/confluence/display/DORIS/Guidance+for+committer+promotion)
diff --git a/docs/zh-CN/developer-guide/cpp-format-code.md b/docs/zh-CN/developer-guide/cpp-format-code.md
index 07c817c7f6..c265eb2bbc 100644
--- a/docs/zh-CN/developer-guide/cpp-format-code.md
+++ b/docs/zh-CN/developer-guide/cpp-format-code.md
@@ -50,6 +50,10 @@ Doris的代码风格在Google Style的基础上稍有改动，定制为 `.clang-
### 下载安装clang-format
+推荐使用 NPM 安装 clang-format 11（不同版本的 clang-format 可能产生不同的代码格式，建议使用 11 版本）：
+
+`npm install clang-format@1.4.0`
+
Ubuntu: `apt-get install clang-format`
当前版本为10.0，也可指定旧版本，例如: `apt-get install clang-format-9`
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org