This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang 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 11cfd701dc8 Update code Conduct (#30374)
11cfd701dc8 is described below
commit 11cfd701dc8553389ad742a43539e400b785dcd5
Author: Liang Zhang <[email protected]>
AuthorDate: Sat Mar 2 17:09:42 2024 +0800
Update code Conduct (#30374)
* Add ReadwriteSplittingDataSourceMapperRuleTest
* Add ReadwriteSplittingDataSourceMapperRuleTest
* Update code Conduct
---
docs/community/content/involved/conduct/code.cn.md | 3 ++-
docs/community/content/involved/conduct/code.en.md | 3 ++-
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/community/content/involved/conduct/code.cn.md
b/docs/community/content/involved/conduct/code.cn.md
index 9889e49347a..ef730c37551 100644
--- a/docs/community/content/involved/conduct/code.cn.md
+++ b/docs/community/content/involved/conduct/code.cn.md
@@ -45,7 +45,8 @@ chapter = true
- 除了直接返回方法入参，返回变量使用 `result` 命名；
- 循环中使用 `each` 命名循环变量；
- map 中使用 `entry` 代替 `each`；
- - 捕获的异常名称命名为 `ex` ；捕获异常且不做任何事情，异常名称命名为 `ignored`。
+ - 捕获的异常名称命名为 `ex` ；
+ - 捕获异常且不做任何事情，异常名称命名为 `ignored`。
- 工具类名称命名为 `xxUtils`。
- 配置文件使用 `Spinal Case` 命名（一种使用 `-` 分割单词的特殊 `Snake Case`）。
- 需要注释解释的代码尽量提成小方法，用方法名称解释。
diff --git a/docs/community/content/involved/conduct/code.en.md
b/docs/community/content/involved/conduct/code.en.md
index c61601ecd37..2cbc19fb23d 100644
--- a/docs/community/content/involved/conduct/code.en.md
+++ b/docs/community/content/involved/conduct/code.en.md
@@ -42,7 +42,8 @@ The following code of conduct is based on full compliance
with [ASF CODE OF COND
- Except return an input parameter as result, returning variable should
be named with `result`;
- Variables in the loop structure are named with `each`;
- Replace `each` with `entry` in map;
- - Exceptions when catch are named with `ex`; Exceptions when catch but do
nothing are named with `ignored`.
+ - Exceptions when catch are named with `ex`;
+ - Exceptions when catch but do nothing are named with `ignored`.
- Utility class should be named in the form of `xxUtils`.
- Name property files with `Spinal Case`(a variant of `Snake Case` which
uses hyphens `-` to separate words).
- Split codes that need to add notes with it into small methods, which are
explained with method names.
