This is an automated email from the ASF dual-hosted git repository.
mikexue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-eventmesh-site.git
The following commit(s) were added to refs/heads/master by this push:
new a0521531 update docs
a0521531 is described below
commit a0521531851d57e029a3014f6de55f4a929afdef
Author: xwm1992 <[email protected]>
AuthorDate: Wed Feb 1 17:38:14 2023 +0800
update docs
---
community/02-how-to-subscribe.md | 2 +-
community/03-how-to-use-email.md | 2 +-
community/{06-contact.md => 05-contact.md} | 0
community/{ => contribute}/01-contribute.md | 0
.../02-write-unit-test.md} | 7 ++++++-
.../03-new-contributor-guidelines.md} | 22 +++++++++++-----------
.../contribute/_category_.json | 2 +-
.../current/02-how-to-subscribe.md | 2 +-
.../current/03-how-to-use-email.md | 2 +-
.../current/{ => contribute}/01-contribute.md | 0
.../current/contribute/02-write-unit-test.md | 5 +++++
.../contribute/03-new-contributor-guidelines.md | 4 ++++
.../current/contribute/_category_.json | 2 +-
13 files changed, 32 insertions(+), 18 deletions(-)
diff --git a/community/02-how-to-subscribe.md b/community/02-how-to-subscribe.md
index 220763ba..2071470e 100644
--- a/community/02-how-to-subscribe.md
+++ b/community/02-how-to-subscribe.md
@@ -1,6 +1,6 @@
---
title: How to Subscribe
-sidebar_position: 1
+sidebar_position: 0
---
# How to Subscribe
diff --git a/community/03-how-to-use-email.md b/community/03-how-to-use-email.md
index e84aeea6..4b980432 100644
--- a/community/03-how-to-use-email.md
+++ b/community/03-how-to-use-email.md
@@ -1,6 +1,6 @@
---
title: How to Use Email
-sidebar_position: 2
+sidebar_position: 1
---
# How to Use Email
diff --git a/community/06-contact.md b/community/05-contact.md
similarity index 100%
rename from community/06-contact.md
rename to community/05-contact.md
diff --git a/community/01-contribute.md b/community/contribute/01-contribute.md
similarity index 100%
copy from community/01-contribute.md
copy to community/contribute/01-contribute.md
diff --git a/community/05-write-unit-test.md
b/community/contribute/02-write-unit-test.md
similarity index 97%
rename from community/05-write-unit-test.md
rename to community/contribute/02-write-unit-test.md
index 70b3c979..8a6879e5 100644
--- a/community/05-write-unit-test.md
+++ b/community/contribute/02-write-unit-test.md
@@ -1,4 +1,9 @@
-# How to Write Unit Test
+---
+title: Unit Test Requirement
+sidebar_position: 1
+---
+
+# Unit Test Requirement
- Each unit test case should use assertions instead of `System.out` output or
`if` statement
- Each unit test case shouldn't call other cases or depend on the order of
execution.
diff --git a/community/01-contribute.md
b/community/contribute/03-new-contributor-guidelines.md
similarity index 89%
rename from community/01-contribute.md
rename to community/contribute/03-new-contributor-guidelines.md
index 7ec1a5ed..21cacba4 100644
--- a/community/01-contribute.md
+++ b/community/contribute/03-new-contributor-guidelines.md
@@ -1,9 +1,9 @@
---
-title: How to Contribute
-sidebar_position: 0
+title: How to Contribution
+sidebar_position: 2
---
-# How to Contribute
+# How to Contribution
If you are a new contributor who wants to contribute to the eventmesh
community, please read this document, which describes how to contribute to the
community, and if you find any questions in the document, feel free to leave
comments or suggestions.
@@ -46,8 +46,8 @@ git checkout -b fix_patch_xx
4. Keep your branch in sync
```git
git remote add upstream [email protected]:apache/incubator-eventmesh.git
-git fetch upstream develop:upstream_develop
-git rebase upstream_develop
+git fetch upstream master:upstream_master
+git rebase upstream_master
```
5. Commit your changes (make sure your commit message concise)
@@ -82,7 +82,7 @@ So fork the original EventMesh repository into your own
repository.
### Documentation Improvement
-- You can find the eventmesh documentation at
[evenmesh-docs](https://github.com/apache/incubator-eventmesh/tree/master/docs),
and the documentation is supplemented or improved in a way that is also
essential for eventmesh.
+- You can find the eventmesh documentation at
[eventmesh-docs](https://github.com/apache/incubator-eventmesh/tree/master/docs),
and the documentation is supplemented or improved in a way that is also
essential for eventmesh.
## Contribution method
@@ -114,9 +114,9 @@ There are two ways for new contributors to contribute to
the eventmesh community
**Note:**
-- A single pull request should not be too large. If heavy changes are
required, it's better to separate the changes to a few individual PRs.
-
-- After creating a PR, one or more committers will help to review the pull
request, after approve, this PR will be merged in to eventmesh repository, and
the related Issue will be closed.
+ - A single pull request should not be too large. If heavy changes are
required, it's better to separate the changes to a few individual PRs.
+
+ - After creating a PR, one or more committers will help to review the pull
request, after approve, this PR will be merged in to eventmesh repository, and
the related Issue will be closed.
## review
@@ -125,9 +125,9 @@ There are two ways for new contributors to contribute to
the eventmesh community
All code should be well reviewed by one or more committers. Some principles:
- Readability: Important code should be well-documented. Comply with our [code
style](https://github.com/apache/incubator-eventmesh/blob/master/style/checkStyle.xml).
-
+
- Elegance: New functions, classes or components should be well-designed.
-
+
- Testability: Important code should be well-tested (high unit test coverage).
### License review
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/_category_.json
b/community/contribute/_category_.json
similarity index 74%
copy from
i18n/zh/docusaurus-plugin-content-docs/current/contribute/_category_.json
copy to community/contribute/_category_.json
index 56d36f91..09bd35ad 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/_category_.json
+++ b/community/contribute/_category_.json
@@ -1,5 +1,5 @@
{
- "position": 5,
+ "position": 2,
"label": "Contribute",
"collapsed": false
}
diff --git
a/i18n/zh/docusaurus-plugin-content-docs-community/current/02-how-to-subscribe.md
b/i18n/zh/docusaurus-plugin-content-docs-community/current/02-how-to-subscribe.md
index cf75ebc0..ec099ef7 100644
---
a/i18n/zh/docusaurus-plugin-content-docs-community/current/02-how-to-subscribe.md
+++
b/i18n/zh/docusaurus-plugin-content-docs-community/current/02-how-to-subscribe.md
@@ -1,6 +1,6 @@
---
title: 如何订阅
-sidebar_position: 1
+sidebar_position: 0
---
# 如何订阅
diff --git
a/i18n/zh/docusaurus-plugin-content-docs-community/current/03-how-to-use-email.md
b/i18n/zh/docusaurus-plugin-content-docs-community/current/03-how-to-use-email.md
index c26bd73d..18046910 100644
---
a/i18n/zh/docusaurus-plugin-content-docs-community/current/03-how-to-use-email.md
+++
b/i18n/zh/docusaurus-plugin-content-docs-community/current/03-how-to-use-email.md
@@ -1,6 +1,6 @@
---
title: 如何使用邮件列表
-sidebar_position: 2
+sidebar_position: 1
---
# 如何使用邮件列表
diff --git
a/i18n/zh/docusaurus-plugin-content-docs-community/current/01-contribute.md
b/i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/01-contribute.md
similarity index 100%
rename from
i18n/zh/docusaurus-plugin-content-docs-community/current/01-contribute.md
rename to
i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/01-contribute.md
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/02-write-unit-test.md
b/i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/02-write-unit-test.md
similarity index 98%
rename from
i18n/zh/docusaurus-plugin-content-docs/current/contribute/02-write-unit-test.md
rename to
i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/02-write-unit-test.md
index 055cdce3..7447ca09 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/02-write-unit-test.md
+++
b/i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/02-write-unit-test.md
@@ -1,3 +1,8 @@
+---
+title: 单元测试要求
+sidebar_position: 1
+---
+
# 单元测试要求
- 每个单元测试都应该使用断言`assertions` 而不是 `System.out` 打印或者`if`语句
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/03-new-contributor-guidelines.md
b/i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/03-new-contributor-guidelines.md
similarity index 99%
rename from
i18n/zh/docusaurus-plugin-content-docs/current/contribute/03-new-contributor-guidelines.md
rename to
i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/03-new-contributor-guidelines.md
index 0564a132..646597ae 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/03-new-contributor-guidelines.md
+++
b/i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/03-new-contributor-guidelines.md
@@ -1,3 +1,7 @@
+---
+title: 如何成为EventMesh的贡献者(Contributor)
+sidebar_position: 2
+---
# 如何成为EventMesh的贡献者(Contributor)
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/_category_.json
b/i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/_category_.json
similarity index 74%
rename from
i18n/zh/docusaurus-plugin-content-docs/current/contribute/_category_.json
rename to
i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/_category_.json
index 56d36f91..09bd35ad 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/_category_.json
+++
b/i18n/zh/docusaurus-plugin-content-docs-community/current/contribute/_category_.json
@@ -1,5 +1,5 @@
{
- "position": 5,
+ "position": 2,
"label": "Contribute",
"collapsed": false
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
