This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 1d2aa5718f5 Update community docs (#31603)
1d2aa5718f5 is described below
commit 1d2aa5718f577a5afc67ff94d8993d31991bcbfa
Author: Liang Zhang <[email protected]>
AuthorDate: Thu Jun 6 16:44:23 2024 +0800
Update community docs (#31603)
---
docs/community/content/involved/conduct/code.cn.md | 8 ++++----
docs/community/content/involved/conduct/code.en.md | 13 ++++++++-----
docs/community/content/team/_index.cn.md | 4 ++--
docs/community/content/team/_index.en.md | 17 ++++++++++-------
4 files changed, 24 insertions(+), 18 deletions(-)
diff --git a/docs/community/content/involved/conduct/code.cn.md
b/docs/community/content/involved/conduct/code.cn.md
index 555504f86e9..ae63a667a01 100644
--- a/docs/community/content/involved/conduct/code.cn.md
+++ b/docs/community/content/involved/conduct/code.cn.md
@@ -117,16 +117,16 @@ chapter = true
- SQL 解析模块涉及的 `G4` 语法文件以及 `SQLVisitor` 实现类，需要根据如下的数据库关系进行差异代码标记。当数据库 A
不提供对应的数据库驱动和协议，而是直接使用数据库 B 的驱动和协议时，可以认为数据库 A 是数据库 B 的分支数据库。
通常分支数据库会直接使用主干数据库的 SQL 解析逻辑，但是为了适配分支数据库的特有语法，部分分支数据库会从主干数据库复制并维护自己的 SQL
解析逻辑，此时对于分支数据库的特有语法，需要使用注释进行标记，其他部分需要和主干数据库的实现保持一致；
- | 主干数据库 | 分支数据库 |
+ | 主干数据库 | 分支数据库 |
|------------|---------------|
| MySQL | MariaDB、Doris |
| PostgreSQL | - |
- | openGauss | - |
+ | openGauss | - |
| Oracle | - |
| SQLServer | - |
| ClickHouse | - |
- | Hive | - |
- | Presto | - |
+ | Hive | - |
+ | Presto | - |
| SQL92 | - |
- 差异代码标记语法，增加时将 `{DatabaseType}` 替换为数据库类型大写名，例如：`DORIS`。
diff --git a/docs/community/content/involved/conduct/code.en.md
b/docs/community/content/involved/conduct/code.en.md
index 34cbf00ea63..abab1d46195 100644
--- a/docs/community/content/involved/conduct/code.en.md
+++ b/docs/community/content/involved/conduct/code.en.md
@@ -8,10 +8,13 @@ The following code of conduct is based on full compliance
with [ASF CODE OF COND
## Development Guidelines
- - Write codes with heart. Pursue clean, simplified and extremely elegant
codes. Agree with concepts in <Refactoring: Improving the Design of Existing
Code> and <Clean Code: A Handbook of Agile Software Craftsmanship>.
- - Be familiar with codes already had, to keep consistent with the style and
use.
- - Highly reusable, no duplicated codes or configurations.
- - Delete codes out of use in time.
+- **Dedication** Uphold a sense of responsibility and awe, continuously honing
your craft.
+- **Readability** Code should be self-explanatory, revealing its purpose
through reading, not debugging.
+- **Cleanliness** Embrace the principles of "Refactoring" and "Clean Code",
striving for clean and elegant code.
+- **Consistency** Maintain complete consistency in code style, naming, and
usage.
+- **Simplicity** Strive for minimalist code, conveying the correct meaning
with the least amount of code. Aim for high reusability, no duplicate code or
configurations. Promptly remove unused code.
+- **Abstraction** Ensure clear division of levels, reasonable abstraction of
concepts. Maintain methods, classes, packages, and modules at the same level of
abstraction.
+- **Excellence** Reject arbitrariness, every line of code, every character,
every space must have its purpose.
## Contributor Covenant Submitting of Conduct
@@ -121,7 +124,7 @@ The following code of conduct is based on full compliance
with [ASF CODE OF COND
| Trunk Database | Branch Database |
|----------------|-----------------|
- | MySQL | MariaDB、Doris |
+ | MySQL | MariaDB, Doris |
| PostgreSQL | - |
| openGauss | - |
| Oracle | - |
diff --git a/docs/community/content/team/_index.cn.md
b/docs/community/content/team/_index.cn.md
index d9c28f087a6..519db2503ae 100644
--- a/docs/community/content/team/_index.cn.md
+++ b/docs/community/content/team/_index.cn.md
@@ -570,7 +570,7 @@ chapter = true
## 成为提交者
-ShardingSphere 社区遵循 [Apache
社区流程](http://community.apache.org/newcommitter.html)来接收新的提交者。
-当您积极参地与 ShardingSphere 社区之后，项目管理委员会和项目官方提交者会根据您的表现发起吸纳您成为官方提交者和项目管理委员会成员的流程。
+ShardingSphere 社区遵循 [Apache
社区流程](http://community.apache.org/newcommitter.html)来接纳新的提交者。
+如果您在 ShardingSphere 社区中积极参与，项目管理委员会将根据您的表现启动流程，邀请您成为提交者和项目管理委员会成员。
您可以阅读[贡献者指南](/cn/involved/contribute/)来参与社区，并通过[提交者指南](/cn/involved/committer/)获取更多信息。
diff --git a/docs/community/content/team/_index.en.md
b/docs/community/content/team/_index.en.md
index 736d2ca66eb..b040e9fd02d 100644
--- a/docs/community/content/team/_index.en.md
+++ b/docs/community/content/team/_index.en.md
@@ -571,13 +571,14 @@ You can find all of the ShardingSphere contributors
directly in GitHub's contrib
## Becoming a Committer
The ShardingSphere community follows the [Apache Community’s
process](http://community.apache.org/newcommitter.html) on accepting a new
committer.
-Contributors that actively participate in ShardingSphere's community will be
invited by the project's (P)PMC and Committers to join them by becoming a
committer.
+Contributors who actively participate in the ShardingSphere community may be
invited to become a committer by the project's PMC and existing committers.
You can read the [Contributor Guide](/en/involved/contribute/) for more
information on how you can contribute to the community, as well as the
[Committer Guide](/en/involved/committer/) for more details on how to become a
committer.
-### How Can I Become a Contributor
+### How Can I become a Contributor
-A contributor simply means that you take an interest in the project and
contribute in some way, ranging from asking questions to providing new features
as code patches. Contributions can be made in many ways, such as:
+A contributor simply means that you take an interest in the project and
contribute in some way, ranging from asking questions to providing new features
as code patches.
+Contributions can be made in many ways, such as:
1. Help others in the issues
- Help solve problems with the issues
- Remind the authors to provide a demo if they are reporting a bug
@@ -589,11 +590,12 @@ A contributor simply means that you take an interest in
the project and contribu
6. Spread the word! Tweet or engage with @ShardingSphere on Twitter
7. Bit of a writer? Consider submitting a piece for publication on the
ShardingSphere Medium page and official blog and we will feature you on all our
media channels as well
-The first step is to get involved. Dive into the Apache ShardingSphere concept
& code, and say hi to the community; offer help, improve docs, complete a
newbie ticket or answer a user. You may just be surprised how welcoming and
open folks are here. The more visible and engaged you are in the project, the
more fun you will have and the more access you will have to advice and
feedback. Contributing is fun and beneficial.
+The first step towards becoming a contributor is to get involved. Dive into
the Apache ShardingSphere concept & code, and say hi to the community; offer
help, improve docs, complete a newbie ticket or answer a user. You may just be
surprised how welcoming and open folks are here. The more visible and engaged
you are in the project, the more fun you will have and the more access you will
have to advice and feedback. Contributing is fun and beneficial.
-### Anyone can become a committer
+### Anyone can become a Committer
-Anyone who contributes to a project in any way is a contributor. If you become
a valuable contributor to the project, the Project Management Committee (PMC)
may invite you to become a committer.
+Anyone who contributes to a project in any way is a contributor.
+If you become a valuable contributor to the project, the Project Management
Committee (PMC) may invite you to become a committer.
It brings with it the privilege of write access to the project repository and
resources, not just read source code files. A committer has the privilege to
write and commit code and create pull requests to the default branch of the
repository and in most cases, reviewers are also committers as you need to
understand the code to review a PR.
In short, the committer is authorized to merge user contributions into the
project.
@@ -606,10 +608,11 @@ Apart from many visible contributions of value in Apache
projects (documentation
- Providing mentorship
### Why should I become a Committer?
+
Committer activity is a good and useful endeavor:
- Being assigned to a Committer role is extremely motivating. A good open
source community like Apache ShardingSphere appreciates your values and
contributions, and you clearly see the results of your work in action.
- Grow both professionally and personally very fast.
- Have an opportunity to connect with top professionals and also pull some
cool ideas.
- Being a Committer is good for CV building and even a greater plus for junior
programmers.
-For more information, please read Guide for new project committers published
by the Apache Software Foundation.
+For more information, please read Guide for new project committers published
by the Apache Software Foundation.
