This is an automated email from the ASF dual-hosted git repository.
jianglongtao 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 a2df10acd70 Update contribute conduct (#20524)
a2df10acd70 is described below
commit a2df10acd704fe42752073115edf714e10f8516b
Author: Liang Zhang <[email protected]>
AuthorDate: Thu Aug 25 20:31:23 2022 +0800
Update contribute conduct (#20524)
---
CONTRIBUTING.md | 2 +-
docs/community/content/contribute/_index.cn.md | 8 ++++----
docs/community/content/contribute/_index.en.md | 5 +++--
docs/community/content/contribute/conduct/_index.cn.md | 7 +++++++
docs/community/content/contribute/conduct/_index.en.md | 7 +++++++
.../{code-conduct.cn.md => conduct/code.cn.md} | 5 +++--
.../{code-conduct.en.md => conduct/code.en.md} | 3 ++-
.../community/content/contribute/conduct/document.cn.md | 16 ++++++++++++++++
.../community/content/contribute/conduct/document.en.md | 17 +++++++++++++++++
.../{issue-conduct.cn.md => conduct/issue.cn.md} | 6 +++---
.../{issue-conduct.en.md => conduct/issue.en.md} | 8 ++++----
docs/community/content/contribute/contributor.cn.md | 2 +-
docs/community/content/contribute/contributor.en.md | 2 +-
.../community/content/contribute/document-conduct.cn.md | 17 -----------------
.../community/content/contribute/document-conduct.en.md | 17 -----------------
.../content/contribute/establish-project.cn.md | 2 +-
.../content/contribute/establish-project.en.md | 2 +-
17 files changed, 71 insertions(+), 55 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 21075408e7c..7b2eaf47094 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -28,7 +28,7 @@ You can report a bug, submit a new feature enhancement
recommendation, or commit
- Reply a deadline message to pickup this issue.
- Find a mentor in [Core developers
list](https://shardingsphere.apache.org/community/en/team/), he will give you
feedback for design and implements.
- Fork to your github repo and begin to work.
- - Please follow Sharding's [Development
conventions](https://shardingsphere.apache.org/community/en/contribute/code-conduct/),
and complete check before pull request submit.
+ - Please follow Sharding's [Development
conventions](https://shardingsphere.apache.org/community/en/contribute/conduct/code/),
and complete check before pull request submit.
- Submit a pull request to master branch when finished.
- Mentor will do code review and discuss some details, include design,
implement, performance and code style. Code will be merged until mentor
accepted.
- Finally, congratulations that you have become the official contributor for
Apache ShardingSphere.
diff --git a/docs/community/content/contribute/_index.cn.md
b/docs/community/content/contribute/_index.cn.md
index 08c9918244c..df8395c25e3 100644
--- a/docs/community/content/contribute/_index.cn.md
+++ b/docs/community/content/contribute/_index.cn.md
@@ -9,12 +9,12 @@ ShardingSphere 是一个开放且活跃的社区，非常欢迎高质量的参
您可以从[订阅官方邮件列表](/cn/contribute/subscribe/)开始参与社区。
-如果你是刚接触 ShardingSphere，请您先阅读[开发环境搭建指南](/cn/contribute/establish-project/)。
+如果您是刚接触 ShardingSphere，请您先阅读[开发环境搭建指南](/cn/contribute/establish-project/)。
-在成为一个贡献者之前，请您阅读[贡献者指南](/cn/contribute/contributor/)、[官方文档指南](/cn/contribute/document-contributor/)以及[开发规范](/cn/contribute/code-conduct/)。
+在成为一个贡献者之前，请您阅读[贡献规范](/cn/contribute/conduct/)。
-如果你想成为官方提交者，请您阅读[提交者指南](/cn/contribute/committer/)。官方提交者需要通过开启
[2FA](/cn/contribute/2fa/) 后，才能够行使 Apache 官方代码仓库权限。
+如果您想成为官方提交者，请您阅读[提交者指南](/cn/contribute/committer/)。官方提交者需要通过开启
[2FA](/cn/contribute/2fa/) 后，才能够行使 Apache 官方代码仓库权限。
-如果你想成为官方版本发布经理，请您阅读[发布指南](/cn/contribute/release/)。
+如果您想成为官方版本发布经理，请您阅读[发布指南](/cn/contribute/release/)。
感谢您关注 ShardingSphere。
diff --git a/docs/community/content/contribute/_index.en.md
b/docs/community/content/contribute/_index.en.md
index 450efc20944..ac3c3b8c8b1 100644
--- a/docs/community/content/contribute/_index.en.md
+++ b/docs/community/content/contribute/_index.en.md
@@ -11,9 +11,10 @@ You may participate in the community through the
[Mailing-list Subscription](/en
If you are just getting started, please read the [Environment Set Up
Guide](/en/contribute/establish-project/) to set up the development environment
for ShardingSphere.
-Before becoming a contributor, please read the [Contributors'
Guide](/en/contribute/contributor/) and [Documents Contributor
Guide](/en/contribute/document-contributor/), as well as the [Code of
Conduct](/en/contribute/code-conduct/).
+Please read the [Contributor Conduct](/en/contribute/conduct/) before becoming
a contributor.
-If you want to become a committer, please read the [Committers'
Guide](/en/contribute/committer/). Committers can be granted authority by the
Apache repo after [2FA](/en/contribute/2fa/) enabled.
+If you want to become a committer, please read the [Committers'
Guide](/en/contribute/committer/).
+Committers can be granted authority by the Apache repo after
[2FA](/en/contribute/2fa/) enabled.
If you want to be a release manager, please read the [Release
Guide](/en/contribute/release/).
diff --git a/docs/community/content/contribute/conduct/_index.cn.md
b/docs/community/content/contribute/conduct/_index.cn.md
new file mode 100644
index 00000000000..b65841a963d
--- /dev/null
+++ b/docs/community/content/contribute/conduct/_index.cn.md
@@ -0,0 +1,7 @@
++++
+title = "贡献规约"
+weight = 8
+chapter = true
++++
+
+请阅读本章节了解参与 Apache ShardingSphere 贡献的规约。
diff --git a/docs/community/content/contribute/conduct/_index.en.md
b/docs/community/content/contribute/conduct/_index.en.md
new file mode 100644
index 00000000000..35cd3462272
--- /dev/null
+++ b/docs/community/content/contribute/conduct/_index.en.md
@@ -0,0 +1,7 @@
++++
+title = "Contribution Conduct"
+weight = 8
+chapter = true
++++
+
+Please read this chapter to know the contribution conduct of Apache
ShardingSphere.
diff --git a/docs/community/content/contribute/code-conduct.cn.md
b/docs/community/content/contribute/conduct/code.cn.md
similarity index 98%
rename from docs/community/content/contribute/code-conduct.cn.md
rename to docs/community/content/contribute/conduct/code.cn.md
index c3c6ad077aa..a4abc904612 100644
--- a/docs/community/content/contribute/code-conduct.cn.md
+++ b/docs/community/content/contribute/conduct/code.cn.md
@@ -1,10 +1,10 @@
+++
title = "开发规范"
-weight = 5
+weight = 2
chapter = true
+++
-以下行为准则以完全遵循
[Apache软件基金会行为准则](https://www.apache.org/foundation/policies/conduct.html)为前提。
+以下行为准则以完全遵循 [Apache
软件基金会行为准则](https://www.apache.org/foundation/policies/conduct.html)为前提。
## 开发理念
@@ -83,6 +83,7 @@ chapter = true
- 使用 Mockito mockStatic 和 mockConstruction 方法必须搭配 try-with-resource
或在清理方法中关闭，避免泄漏。
## G4 编码规范
+
- 公共规范
- 每行长度不超过 `200` 个字符，保证每一行语义完整以便于理解。
- 词法解析规范
diff --git a/docs/community/content/contribute/code-conduct.en.md
b/docs/community/content/contribute/conduct/code.en.md
similarity index 99%
rename from docs/community/content/contribute/code-conduct.en.md
rename to docs/community/content/contribute/conduct/code.en.md
index b14206a13cc..c8d9352d955 100644
--- a/docs/community/content/contribute/code-conduct.en.md
+++ b/docs/community/content/contribute/conduct/code.en.md
@@ -1,6 +1,6 @@
+++
title = "Code of Conduct"
-weight = 5
+weight = 2
chapter = true
+++
@@ -81,6 +81,7 @@ The following code of conduct is based on full compliance
with [ASF CODE OF COND
- Mockito mockStatic and mockConstruction methods must be used with
try-with-resource or closed in the teardown method to avoid leaks.
## Contributor Covenant G4 Code of Conduct
+
- Common Conduct
- Every line cannot over `200` chars, guarantee every line have complete
semantics.
- Lexer Conduct
diff --git a/docs/community/content/contribute/conduct/document.cn.md
b/docs/community/content/contribute/conduct/document.cn.md
new file mode 100644
index 00000000000..94a90f20bc2
--- /dev/null
+++ b/docs/community/content/contribute/conduct/document.cn.md
@@ -0,0 +1,16 @@
++++
+title = "文档规范"
+weight = 3
+chapter = true
++++
+
+- 文档标题仅在 `title = "xxx"` 中出现， 文档内部无需主标题（#）；
+- 每篇文档结尾留一空行；
+- 为避免段落段落过长，请在句号结尾处换行；
+- 标题和内容需要保留空行；
+- 为方便阅读，除了最后一列，表格的每列需要严格对齐；
+- 表格表头的 `|` 与 `-` 之间需要保留一个空格；
+- 数字标记的段落均使用 `1.` ，由 Hugo 自动生成序号；
+- 列表项使用`；`结尾，最后一项用`。`结尾；
+- 请勿在英文文档中使用中文字符；
+- 中英文之间需要空格。
diff --git a/docs/community/content/contribute/conduct/document.en.md
b/docs/community/content/contribute/conduct/document.en.md
new file mode 100644
index 00000000000..9e860cfffe2
--- /dev/null
+++ b/docs/community/content/contribute/conduct/document.en.md
@@ -0,0 +1,17 @@
++++
+title = "Document of Conduct"
+weight = 3
+chapter = true
++++
+
+- The title of topic should in `title = "xxx"` only, content should not
include main title(#);
+- Please leave a blank line at the end of topic;
+- To avoid segment too long, please start a new line after full stop;
+- Please keep a blank line between title and content;
+- For reading friendly, please arrange for each column in table beside last
one;
+- Please keep space between `|` and `-` in head of table;
+- Please use `1.` for number item, it can be generated correct number by Hugo
automatically;
+- Item list is preceded by `;` at the end, the last item is marked with `.`
ending;
+- Please end of `;` by item list, and end of `.` for the last item list;
+- Please do not use Chinese characters in English topics;
+- Spaces needed between Chinese and English.
diff --git a/docs/community/content/contribute/issue-conduct.cn.md
b/docs/community/content/contribute/conduct/issue.cn.md
similarity index 90%
rename from docs/community/content/contribute/issue-conduct.cn.md
rename to docs/community/content/contribute/conduct/issue.cn.md
index 7277d40d50f..97dd2b89231 100644
--- a/docs/community/content/contribute/issue-conduct.cn.md
+++ b/docs/community/content/contribute/conduct/issue.cn.md
@@ -1,15 +1,15 @@
+++
title = "Issue 提交与处理规范"
-weight = 6
+weight = 1
chapter = true
+++
## Issue 提交规范
- - Issue 列表以可读和可检索为目标。提交者有义务将标题总结的有意义和易于检索，并保持内容的正确和完整性；
+ - Issue 列表以可读和可检索为目标，提交者有义务将标题总结的有意义和易于检索，并保持内容的正确和完整性；
- 请在经过充分的检索之后，确定无相关的已存在 Issue，再提交新的 Issue；
- Issue 类型划分为缺陷报告、新功能请求和问题，请在提交 Issue 时选择正确的模板并根据模板填写其内容；
- - 由配置不确定等产生的问题，请将相关的可重现代码提交至 Github，以便于社区贡献者定位和确定问题；
+ - 由配置不确定等产生的问题，请将相关的可重现代码提交至 GitHub，以便于社区贡献者定位和确定问题；
- 请在 Issue 得到解决之后，回复该 Issue，形成闭环，为其他浏览此 Issue 的读者提供有效信息；
- 请及时关注已提交的 Issue，长时间无反馈的 Issue 将定期关闭；
- 为保证社区多元化，请使用英文参与交流。
diff --git a/docs/community/content/contribute/issue-conduct.en.md
b/docs/community/content/contribute/conduct/issue.en.md
similarity index 90%
rename from docs/community/content/contribute/issue-conduct.en.md
rename to docs/community/content/contribute/conduct/issue.en.md
index a40fb47b12c..fb1195738da 100644
--- a/docs/community/content/contribute/issue-conduct.en.md
+++ b/docs/community/content/contribute/conduct/issue.en.md
@@ -1,15 +1,15 @@
+++
-title = "Issue Conduct"
-weight = 6
+title = "Issue of Conduct"
+weight = 1
chapter = true
+++
## Issue Submit Conduct
- - Issue lists should be readable and retrievable. The author is obligated to
summarize the title that is meaningful and convenient for retrieval, and to
ensure the correctness and completeness of the content;
+ - Issue lists should be readable and retrievable, the author is obligated to
summarize the title that is meaningful and convenient for retrieval, and to
ensure the correctness and completeness of the content;
- Please confirm that there is no relevant existing Issue after sufficient
search, and then submit a new Issue;
- The type of issue is divided into bug, new feature and problem. When you
edit an issue, please select the correct template and fill in content according
to the template;
- - For problems caused by uncertain configuration, please submit the relevant
reproducible code to Github, so that community contributors can locate and
identify the problem more efficiently;
+ - For problems caused by uncertain configuration, please submit the relevant
reproducible code to GitHub, so that community contributors can locate and
identify the problem more efficiently;
- Please reply to the Issue after it has been resolved to form a closed loop
that will provide effective information for others who browse the Issue;
- Please pay attention to the submitted issues in time. Issues with no
feedback for a long time will be closed regularly.
- Please use English for community diversity.
diff --git a/docs/community/content/contribute/contributor.cn.md
b/docs/community/content/contribute/contributor.cn.md
index 73056180dd0..5c7a27a6040 100644
--- a/docs/community/content/contribute/contributor.cn.md
+++ b/docs/community/content/contribute/contributor.cn.md
@@ -66,7 +66,7 @@ git checkout -b issueNo
**4. 编码**
- - 请您在开发过程中遵循 ShardingSphere 的[开发规范](/cn/contribute/code-conduct/)。并在准备提交 pull
request 之前完成相应的检查。
+ - 请您在开发过程中遵循 ShardingSphere 的[开发规范](/cn/contribute/conduct/code/)。并在准备提交 pull
request 之前完成相应的检查。
- 将修改的代码 push 到 fork 库的分支上。
```shell
diff --git a/docs/community/content/contribute/contributor.en.md
b/docs/community/content/contribute/contributor.en.md
index 341af4ccca2..3949d1247a5 100644
--- a/docs/community/content/contribute/contributor.en.md
+++ b/docs/community/content/contribute/contributor.en.md
@@ -66,7 +66,7 @@ git checkout -b issueNo
**4. Coding**
- - Please obey the [Code of Conduct](/en/contribute/code-conduct/) during the
process of development and finish the check before submitting the pull request.
+ - Please obey the [Code of Conduct](/en/contribute/conduct/code/) during the
process of development and finish the check before submitting the pull request.
- push code to your fork repo.
```shell
diff --git a/docs/community/content/contribute/document-conduct.cn.md
b/docs/community/content/contribute/document-conduct.cn.md
deleted file mode 100644
index 854d955e402..00000000000
--- a/docs/community/content/contribute/document-conduct.cn.md
+++ /dev/null
@@ -1,17 +0,0 @@
-+++
-title = "文档规范"
-weight = 6
-chapter = true
-+++
-
-- 每个 Topic 不用写标题，GitHub 支持标题的自动生成。
-- 每个表格要严格按照表格样式排版，以便后续人员看清楚和接手。
-- 段落的句号结尾要换行，否则会造成某段落太长。
-- 每个 Topic 的结尾留一空行。
-- 每个 Topic 里面的 Title 前要空行。
-- 每个 Topic 的文件名命名要有意义。
-- 英文文档不要使用中文字符。
-- 每个表头的 | 和 - 之间要加一个空格。
-- 操作步骤均使用 `1.` 可自动生成序号。
-- Item List 前面都用“；”结尾，最后一项用“。”结尾。
-- 中英文之间需要增加空格。
diff --git a/docs/community/content/contribute/document-conduct.en.md
b/docs/community/content/contribute/document-conduct.en.md
deleted file mode 100644
index 5d3fa6c3437..00000000000
--- a/docs/community/content/contribute/document-conduct.en.md
+++ /dev/null
@@ -1,17 +0,0 @@
-+++
-title = "Document Specification"
-weight = 6
-chapter = true
-+++
-
-- Each topic does not need to write a title. GitHub supports the automatic
generation of titles.
-- Each table shall be arranged in strict accordance with the table style so
that follow-up personnel can see clearly and take over.
-- The end of the period of a paragraph should be wrapped, otherwise a
paragraph will be too long.
-- Leave a blank line at the end of each topic.
-- There should be a blank line before the title in each topic.
-- The file name of each topic should be meaningful.
-- Do not use Chinese characters in English documents.
-- A space shall be added between | and - in each header.
-- The sequence number can be automatically generated by using '1.'.
-- Item list is preceded by ';' at the end, the last item is marked with "."
ending.
-- Spaces need to be added between Chinese and English.
diff --git a/docs/community/content/contribute/establish-project.cn.md
b/docs/community/content/contribute/establish-project.cn.md
index b7ae446aa46..d0e91cc178f 100644
--- a/docs/community/content/contribute/establish-project.cn.md
+++ b/docs/community/content/contribute/establish-project.cn.md
@@ -75,7 +75,7 @@ git config --global core.longpaths true
以下是一些常用插件：
- Lombok：必须。最新版 IntelliJ IDEA 已自带。
-- CheckStyle：可选。可以实时或根据需要扫描 Java 文件，找出不符合代码规范的地方并提示。**注意**：不是所有不符合
[代码规范](/cn/contribute/code-conduct/) 的地方都可以被检查出来。
+- CheckStyle：可选。可以实时或根据需要扫描 Java 文件，找出不符合代码规范的地方并提示。**注意**：不是所有不符合
[代码规范](/cn/contribute/conduct/code/) 的地方都可以被检查出来。
- ANTLR v4：可选。做 SQL 语法扩展任务的时候可能有用。
### CheckStyle 插件配置
diff --git a/docs/community/content/contribute/establish-project.en.md
b/docs/community/content/contribute/establish-project.en.md
index 7e38afadf51..c0896b979ad 100644
--- a/docs/community/content/contribute/establish-project.en.md
+++ b/docs/community/content/contribute/establish-project.en.md
@@ -75,7 +75,7 @@ You could use any of them:
These plugins might be useful for you:
- Lombok : Required. It's already preinstalled in the latest IntelliJ IDEA.
-- CheckStyle : Optional. It provides both real-time and on-demand scanning of
Java files. **Notice**: Not all [Code of Conduct](/en/contribute/code-conduct/)
could be checked.
+- CheckStyle : Optional. It provides both real-time and on-demand scanning of
Java files. **Notice**: Not all [Code of Conduct](/en/contribute/conduct/code/)
could be checked.
- ANTLR v4 : Optional. It's recommended if you contribute to SQL extension.
### CheckStyle Settings
