This is an automated email from the ASF dual-hosted git repository.
albumenj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/dubbo-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 1c0d1c6 update CONTRIBUTING.md and README (#110)
1c0d1c6 is described below
commit 1c0d1c614dd31e34bb50608a0137849ea1df753e
Author: Robert LU <[email protected]>
AuthorDate: Tue Feb 14 14:58:56 2023 +0800
update CONTRIBUTING.md and README (#110)
* Rename contributing.md to CONTRIBUTING.md
* add Formating and Debugging
* update README
---
contributing.md => CONTRIBUTING.md | 31 +++++++++++++++++++++++
README.md | 5 ++--
README_CN.md | 7 ++---
docs/images/{eamples => examples}/client.png | Bin
docs/images/{eamples => examples}/dir-server.png | Bin
docs/images/{eamples => examples}/server.png | Bin
examples/{READMED.md => README.md} | 8 +++---
7 files changed, 42 insertions(+), 9 deletions(-)
diff --git a/contributing.md b/CONTRIBUTING.md
similarity index 64%
rename from contributing.md
rename to CONTRIBUTING.md
index dc3c587..ccdb37c 100644
--- a/contributing.md
+++ b/CONTRIBUTING.md
@@ -29,3 +29,34 @@ The title format of the pull request `MUST` follow the
following rules:
### 3.1 log
> 1 when logging the function's input parameter, you should add '@' before
> input parameter name.
+
+## 4. Dev
+
+### 4.1 Formating
+
+Currently, dubbo-rust recommand using rustfmt nightly version for formating:
+1. `rustup toolchain install nightly --component rustfmt`
+2. configure `settings.json`:
+```json
+{
+ "rust-analyzer.rustfmt.overrideCommand": ["cargo", "+nightly", "fmt"]
+}
+```
+
+### 4.2 Debugging
+
+Example launch configuration:
+```json
+{
+ "type": "lldb",
+ "request": "launch",
+ "name": "greeter-server",
+ "program": "${workspaceFolder}/target/debug/greeter-server",
+ "args": [],
+ "cwd": "${workspaceFolder}/examples/greeter/",
+ "terminal": "console",
+ "env": {
+ "ZOOKEEPER_SERVERS": "mse-21b397d4-p.zk.mse.aliyuncs.com:2181",
+ }
+}
+```
diff --git a/README.md b/README.md
index aac8766..28d7a9d 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,8 @@
Apache Dubbo-rust, an RPC framework that implements Dubbo written in
Rust.Please visit the [official website](https://dubbo.apache.org/) for more
information.
-[](https://travis-ci.org/apache/dubbo-rust)
+[](https://github.com/apache/dubbo-rust/actions/workflows/github-actions.yml?query=branch%3Amain)
+
[ [中文](./README_CN.md) ]
@@ -73,7 +74,7 @@ more ...
## Contribute
-Welcome more developers to join us. About more details please check "[How to
contribute](https://github.com/apache/dubbo-rust/blob/main/contributing.md)".
+Welcome more developers to join us. About more details please check "[How to
contribute](https://github.com/apache/dubbo-rust/blob/main/CONTRIBUTING.md)".
## License
diff --git a/README_CN.md b/README_CN.md
index 2d2fbbc..b6af21b 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -5,7 +5,8 @@
Apache Dubbo-rust, Dubbo RPC框架的Rust实现。请访问 [Dubbo官网](https://dubbo.apache.org/)
查看更多信息.
-[](https://travis-ci.org/apache/dubbo-rust)
+[](https://github.com/apache/dubbo-rust/actions/workflows/github-actions.yml?query=branch%3Amain)
+
## 概述
@@ -32,7 +33,7 @@ Dubbo-rust 目前还在开发阶段. 截至目前, 已经实现了基于HTTP2的
## 开始使用
- Dubbo-rust 快速开始:
[中文](https://dubbo.apache.org/zh/docs3-v2/rust-sdk/quick-start/), English
-- Dubbo-rust 教程: [Examples](examples/READMED.md)
+- Dubbo-rust 教程: [Examples](examples/README.md)
## 项目结构
@@ -71,7 +72,7 @@ more ...
## 贡献
-欢迎更多的开发者加入我们。关于更多的信息可以查看
[[CONTRIBUTING](https://github.com/apache/dubbo-rust/blob/main/contributing.md)]。
+欢迎更多的开发者加入我们。关于更多的信息可以查看
[[CONTRIBUTING](https://github.com/apache/dubbo-rust/blob/main/CONTRIBUTING.md)]。
## 许可证
diff --git a/docs/images/eamples/client.png b/docs/images/examples/client.png
similarity index 100%
rename from docs/images/eamples/client.png
rename to docs/images/examples/client.png
diff --git a/docs/images/eamples/dir-server.png
b/docs/images/examples/dir-server.png
similarity index 100%
rename from docs/images/eamples/dir-server.png
rename to docs/images/examples/dir-server.png
diff --git a/docs/images/eamples/server.png b/docs/images/examples/server.png
similarity index 100%
rename from docs/images/eamples/server.png
rename to docs/images/examples/server.png
diff --git a/examples/READMED.md b/examples/README.md
similarity index 90%
rename from examples/READMED.md
rename to examples/README.md
index e2e94ac..456d5a2 100644
--- a/examples/READMED.md
+++ b/examples/README.md
@@ -14,7 +14,7 @@ mkdir .vscode
创建个json文件，名称为launch.json，该文件 **.vscode** 目录下 将下文的内容复制到launch.json中
-```json
+```jsonc
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
@@ -47,12 +47,12 @@ mkdir .vscode
#### 打开 examples/greeter/src/greeter 目录，选择server.rs
-
+
#### 选择左侧的运行按钮，启动 server 服务
-
+
##### 启动 client 访问server 端
-
+
