Skip to content

Commit 1c0d1c6

Browse files
authored
update CONTRIBUTING.md and README (#110)
* Rename contributing.md to CONTRIBUTING.md * add Formating and Debugging * update README
1 parent 295f891 commit 1c0d1c6

File tree

7 files changed

+42
-9
lines changed

7 files changed

+42
-9
lines changed

contributing.md renamed to CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,34 @@ The title format of the pull request `MUST` follow the following rules:
2929
### 3.1 log
3030

3131
> 1 when logging the function's input parameter, you should add '@' before input parameter name.
32+
33+
## 4. Dev
34+
35+
### 4.1 Formating
36+
37+
Currently, dubbo-rust recommand using rustfmt nightly version for formating:
38+
1. `rustup toolchain install nightly --component rustfmt`
39+
2. configure `settings.json`:
40+
```json
41+
{
42+
"rust-analyzer.rustfmt.overrideCommand": ["cargo", "+nightly", "fmt"]
43+
}
44+
```
45+
46+
### 4.2 Debugging
47+
48+
Example launch configuration:
49+
```json
50+
{
51+
"type": "lldb",
52+
"request": "launch",
53+
"name": "greeter-server",
54+
"program": "${workspaceFolder}/target/debug/greeter-server",
55+
"args": [],
56+
"cwd": "${workspaceFolder}/examples/greeter/",
57+
"terminal": "console",
58+
"env": {
59+
"ZOOKEEPER_SERVERS": "mse-21b397d4-p.zk.mse.aliyuncs.com:2181",
60+
}
61+
}
62+
```

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
Apache Dubbo-rust, an RPC framework that implements Dubbo written in Rust.Please visit the [official website](https://dubbo.apache.org/) for more information.
77

8-
[![Build Status](https://travis-ci.org/apache/dubbo-rust.svg?branch=main)](https://travis-ci.org/apache/dubbo-rust) ![License](https://img.shields.io/github/license/alibaba/dubbo.svg)
8+
[![Build Status](https://img.shields.io/github/actions/workflow/status/apache/dubbo-rust/.github/workflows/github-actions.yml?branch=main&style=flat-square)](https://github.com/apache/dubbo-rust/actions/workflows/github-actions.yml?query=branch%3Amain)
9+
![License](https://img.shields.io/github/license/apache/dubbo-rust?style=flat-square)
910

1011
[ [中文](./README_CN.md) ]
1112

@@ -73,7 +74,7 @@ more ...
7374

7475
## Contribute
7576

76-
Welcome more developers to join us. About more details please check "[How to contribute](https://github.com/apache/dubbo-rust/blob/main/contributing.md)".
77+
Welcome more developers to join us. About more details please check "[How to contribute](https://github.com/apache/dubbo-rust/blob/main/CONTRIBUTING.md)".
7778

7879
## License
7980

README_CN.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
Apache Dubbo-rust, Dubbo RPC框架的Rust实现。请访问 [Dubbo官网](https://dubbo.apache.org/) 查看更多信息.
77

8-
[![Build Status](https://travis-ci.org/apache/dubbo-rust.svg?branch=main)](https://travis-ci.org/apache/dubbo-rust) ![License](https://img.shields.io/github/license/alibaba/dubbo.svg)
8+
[![Build Status](https://img.shields.io/github/actions/workflow/status/apache/dubbo-rust/.github/workflows/github-actions.yml?branch=main&style=flat-square)](https://github.com/apache/dubbo-rust/actions/workflows/github-actions.yml?query=branch%3Amain)
9+
![License](https://img.shields.io/github/license/apache/dubbo-rust?style=flat-square)
910

1011
## 概述
1112

@@ -32,7 +33,7 @@ Dubbo-rust 目前还在开发阶段. 截至目前, 已经实现了基于HTTP2的
3233
## 开始使用
3334

3435
- Dubbo-rust 快速开始: [中文](https://dubbo.apache.org/zh/docs3-v2/rust-sdk/quick-start/), English
35-
- Dubbo-rust 教程: [Examples](examples/READMED.md)
36+
- Dubbo-rust 教程: [Examples](examples/README.md)
3637

3738
## 项目结构
3839

@@ -71,7 +72,7 @@ more ...
7172

7273
## 贡献
7374

74-
欢迎更多的开发者加入我们。关于更多的信息可以查看 [[CONTRIBUTING](https://github.com/apache/dubbo-rust/blob/main/contributing.md)]
75+
欢迎更多的开发者加入我们。关于更多的信息可以查看 [[CONTRIBUTING](https://github.com/apache/dubbo-rust/blob/main/CONTRIBUTING.md)]
7576

7677
## 许可证
7778

File renamed without changes.
File renamed without changes.

examples/READMED.md renamed to examples/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ mkdir .vscode
1414

1515
创建个json文件,名称为launch.json,该文件 **.vscode** 目录下 将下文的内容复制到launch.json中
1616

17-
```json
17+
```jsonc
1818
{
1919
// Use IntelliSense to learn about possible attributes.
2020
// Hover to view descriptions of existing attributes.
@@ -47,12 +47,12 @@ mkdir .vscode
4747

4848
#### 打开 examples/greeter/src/greeter 目录,选择server.rs
4949

50-
![image.png](../docs/images/eamples/dir-server.png)
50+
![image.png](../docs/images/examples/dir-server.png)
5151

5252
#### 选择左侧的运行按钮,启动 server 服务
5353

54-
![image.png](../docs/images/eamples/server.png)
54+
![image.png](../docs/images/examples/server.png)
5555

5656
##### 启动 client 访问server 端
5757

58-
![image.png](../docs/images/eamples/client.png)
58+
![image.png](../docs/images/examples/client.png)

0 commit comments

Comments
 (0)