From 722e940d0b6758ffa6d16fc05e53aafa7d4c521e Mon Sep 17 00:00:00 2001
From: "Xinwei Xiong (cubxxw)" <3293172751nss@gmail.com>
Date: Fri, 2 Feb 2024 11:00:40 +0800
Subject: [PATCH] feat: support openim readme docs
Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>
---
CONTRIBUTING-zh_CN.md | 33 +++++++++++
CONTRIBUTING.md | 32 ++++++++++
.../readme/README-zh_CN.md => README-zh_CN.md | 58 +++++++++++++------
README.md | 54 ++++++++---------
cmd/openim-push/main.go | 35 ++++++++++-
docs/contribute/CONTRIBUTING-zh_CN.md | 1 -
docs/contributing/CONTRIBUTING-JP.md | 33 +++++++++++
docs/contributing/CONTRIBUTING-PL.md | 33 +++++++++++
8 files changed, 232 insertions(+), 47 deletions(-)
create mode 100644 CONTRIBUTING-zh_CN.md
rename docs/readme/README-zh_CN.md => README-zh_CN.md (66%)
delete mode 100644 docs/contribute/CONTRIBUTING-zh_CN.md
create mode 100644 docs/contributing/CONTRIBUTING-JP.md
create mode 100644 docs/contributing/CONTRIBUTING-PL.md
diff --git a/CONTRIBUTING-zh_CN.md b/CONTRIBUTING-zh_CN.md
new file mode 100644
index 000000000..ee3c0b8f8
--- /dev/null
+++ b/CONTRIBUTING-zh_CN.md
@@ -0,0 +1,33 @@
+# How do I contribute code to OpenIM
+
+
+ Englist ·
+ 中文 ·
+ Українська ·
+ Česky ·
+ Magyar ·
+ Español ·
+ فارسی ·
+ Français ·
+ Deutsch ·
+ Polski ·
+ Indonesian ·
+ Suomi ·
+ മലയാളം ·
+ 日本語 ·
+ Nederlands ·
+ Italiano ·
+ Русский ·
+ Português (Brasil) ·
+ Esperanto ·
+ 한국어 ·
+ العربي ·
+ Tiếng Việt ·
+ Dansk ·
+ Ελληνικά ·
+ Türkçe
+
+
+
+
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e0202d5d6..f7d2c0749 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,37 @@
# How do I contribute code to OpenIM
+
+ Englist ·
+ 中文 ·
+ Українська ·
+ Česky ·
+ Magyar ·
+ Español ·
+ فارسی ·
+ Français ·
+ Deutsch ·
+ Polski ·
+ Indonesian ·
+ Suomi ·
+ മലയാളം ·
+ 日本語 ·
+ Nederlands ·
+ Italiano ·
+ Русский ·
+ Português (Brasil) ·
+ Esperanto ·
+ 한국어 ·
+ العربي ·
+ Tiếng Việt ·
+ Dansk ·
+ Ελληνικά ·
+ Türkçe
+
+
+
+
+
+
So, you want to hack on open-im-server? Yay!
First of all, thank you for considering contributing to our project! We appreciate your time and effort, and we value any contribution, whether it's reporting a bug, suggesting a new feature, or submitting a pull request.
diff --git a/docs/readme/README-zh_CN.md b/README-zh_CN.md
similarity index 66%
rename from docs/readme/README-zh_CN.md
rename to README-zh_CN.md
index 12a56d4f6..e33768881 100644
--- a/docs/readme/README-zh_CN.md
+++ b/README-zh_CN.md
@@ -4,29 +4,51 @@
-
- ⭐️ Open source Instant Messaging Server ⭐️
-
-
-
-
-
-
-
-
-
-
-
+
+
+[](https://github.com/openimsdk/open-im-server/stargazers)
+[](https://github.com/openimsdk/open-im-server/network/members)
+[](https://app.codecov.io/gh/openimsdk/open-im-server)
+[](https://goreportcard.com/report/github.com/openimsdk/open-im-server)
+[](https://pkg.go.dev/github.com/openimsdk/open-im-server/v3)
+[](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)
+[](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
+[](https://www.bestpractices.dev/projects/8045)
+[](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
+[](https://golang.org/)
-
- English •
- 简体中文 •
- Docs
+ Englist ·
+ 中文 ·
+ Українська ·
+ Česky ·
+ Magyar ·
+ Español ·
+ فارسی ·
+ Français ·
+ Deutsch ·
+ Polski ·
+ Indonesian ·
+ Suomi ·
+ മലയാളം ·
+ 日本語 ·
+ Nederlands ·
+ Italiano ·
+ Русский ·
+ Português (Brasil) ·
+ Esperanto ·
+ 한국어 ·
+ العربي ·
+ Tiếng Việt ·
+ Dansk ·
+ Ελληνικά ·
+ Türkçe
+
+ Englist ·
+ 中文 ·
+ Українська ·
+ Česky ·
+ Magyar ·
+ Español ·
+ فارسی ·
+ Français ·
+ Deutsch ·
+ Polski ·
+ Indonesian ·
+ Suomi ·
+ മലയാളം ·
+ 日本語 ·
+ Nederlands ·
+ Italiano ·
+ Русский ·
+ Português (Brasil) ·
+ Esperanto ·
+ 한국어 ·
+ العربي ·
+ Tiếng Việt ·
+ Dansk ·
+ Ελληνικά ·
+ Türkçe
+
diff --git a/cmd/openim-push/main.go b/cmd/openim-push/main.go
index c19cfda60..eb5888d2e 100644
--- a/cmd/openim-push/main.go
+++ b/cmd/openim-push/main.go
@@ -24,7 +24,40 @@ func main() {
pushCmd := cmd.NewRpcCmd(cmd.RpcPushServer)
pushCmd.AddPortFlag()
pushCmd.AddPrometheusPortFlag()
- if err := pushCmd.Exec(); err != nil {
+ if err := pushCmd.Exec(); err != nil {# How do I contribute code to OpenIM
+
+
+ Englist ·
+ 中文 ·
+ Українська ·
+ Česky ·
+ Magyar ·
+ Español ·
+ فارسی ·
+ Français ·
+ Deutsch ·
+ Polski ·
+ Indonesian ·
+ Suomi ·
+ മലയാളം ·
+ 日本語 ·
+ Nederlands ·
+ Italiano ·
+ Русский ·
+ Português (Brasil) ·
+ Esperanto ·
+ 한국어 ·
+ العربي ·
+ Tiếng Việt ·
+ Dansk ·
+ Ελληνικά ·
+ Türkçe
+
+
+
+
+
+
panic(err.Error())
}
if err := pushCmd.StartSvr(config.Config.RpcRegisterName.OpenImPushName, push.Start); err != nil {
diff --git a/docs/contribute/CONTRIBUTING-zh_CN.md b/docs/contribute/CONTRIBUTING-zh_CN.md
deleted file mode 100644
index 99eeef763..000000000
--- a/docs/contribute/CONTRIBUTING-zh_CN.md
+++ /dev/null
@@ -1 +0,0 @@
-# 如何为 OpenIM 贡献代码
diff --git a/docs/contributing/CONTRIBUTING-JP.md b/docs/contributing/CONTRIBUTING-JP.md
new file mode 100644
index 000000000..86bbfefcd
--- /dev/null
+++ b/docs/contributing/CONTRIBUTING-JP.md
@@ -0,0 +1,33 @@
+# How do I contribute code to OpenIM
+
+
+ Englist ·
+ 中文 ·
+ Українська ·
+ Česky ·
+ Magyar ·
+ Español ·
+ فارسی ·
+ Français ·
+ Deutsch ·
+ Polski ·
+ Indonesian ·
+ Suomi ·
+ മലയാളം ·
+ 日本語 ·
+ Nederlands ·
+ Italiano ·
+ Русский ·
+ Português (Brasil) ·
+ Esperanto ·
+ 한국어 ·
+ العربي ·
+ Tiếng Việt ·
+ Dansk ·
+ Ελληνικά ·
+ Türkçe
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/contributing/CONTRIBUTING-PL.md b/docs/contributing/CONTRIBUTING-PL.md
new file mode 100644
index 000000000..86bbfefcd
--- /dev/null
+++ b/docs/contributing/CONTRIBUTING-PL.md
@@ -0,0 +1,33 @@
+# How do I contribute code to OpenIM
+
+
+ Englist ·
+ 中文 ·
+ Українська ·
+ Česky ·
+ Magyar ·
+ Español ·
+ فارسی ·
+ Français ·
+ Deutsch ·
+ Polski ·
+ Indonesian ·
+ Suomi ·
+ മലയാളം ·
+ 日本語 ·
+ Nederlands ·
+ Italiano ·
+ Русский ·
+ Português (Brasil) ·
+ Esperanto ·
+ 한국어 ·
+ العربي ·
+ Tiếng Việt ·
+ Dansk ·
+ Ελληνικά ·
+ Türkçe
+
+
+
+
+
\ No newline at end of file