Skip to content

Commit 89f9e65

Browse files
committed
review & updates
1 parent b536688 commit 89f9e65

File tree

1 file changed

+32
-29
lines changed

1 file changed

+32
-29
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Contributing
22

3-
我们提倡您通过提 issue 和 pull request 方式来促进 WePY 的发展。
3+
我们提倡您通过提 issue 和 pull request 方式来促进 WePY 的发展。
44

5-
65

76
## Acknowledgements
87

@@ -14,13 +13,13 @@
1413

1514
其中特别致谢 dlhandsome 提交的38个 commits, 对 WePY 做出了1,350增加和362处删减(截止02/28/18日)。
1615

17-
WePy 持续招募贡献者,即使是在 Issues 中回答问题,或者做一些简单的 bugfix ,也会给 WePY 带来很大的帮助。
16+
WePY 持续招募贡献者,即使是在 issue 中回答问题,或者做一些简单的 bugfix ,也会给 WePY 带来很大的帮助。
1817

19-
Wepy 已开发近一年,在此感谢所有开发者对于 WePY 的喜欢和支持,希望你能够成为 WePY 的核心贡献者,加入 WePY ,共同打造一个更棒的小程序开发框架!🍾🎉
18+
WePY 已开发近一年,在此感谢所有开发者对于 WePY 的喜欢和支持,希望你能够成为 WePY 的核心贡献者,加入 WePY ,共同打造一个更棒的小程序开发框架!🍾🎉
2019

2120
2221

23-
## Issue提交
22+
## Issue 提交
2423

2524
#### 对于贡献者
2625

@@ -35,63 +34,67 @@ Wepy 已开发近一年,在此感谢所有开发者对于 WePY 的喜欢和支
3534

3635
3736

38-
## Pull requests
37+
## Pull request
3938

4039
我们除了希望听到您的反馈和建议外,我们也希望您接受代码形式的直接帮助,对我们的 GitHub 发出 pull request 请求。
4140

4241
以下是具体步骤:
4342

4443
#### Fork仓库
4544

46-
1. 将需要参与的项目仓库 fork 到自己的 Github 中
45+
点击 `Fork` 按钮,将需要参与的项目仓库 fork 到自己的 Github 中
4746

48-
#### git clone 这个 fork 的项目
47+
#### Clone 已 fork 项目
4948

50-
1. 将自己的 github 中,找到 fork 下来的项目,git clone 到本地。
49+
在自己的 github 中,找到 fork 下来的项目,git clone 到本地。
50+
51+
```bash
52+
$ git clone [email protected]:<yourname>/wepy.git
53+
```
5154

5255
#### 添加 WePY 仓库
5356

54-
1. 接着上一步,在该项目中,执行以下操作,将上游仓库连接到本地仓库,即我们 fork 的地址
57+
fork 源仓库连接到本地仓库
5558

56-
```
57-
git remote add <name> <url>
58-
//例如:
59-
git remote add wepy https://github.com/Tencent/wepy.git
59+
```bash
60+
$ git remote add <name> <url>
61+
# 例如:
62+
$ git remote add wepy git@github.com:Tencent/wepy.git
6063
```
6164

6265
#### 保持与 WePY 仓库的同步
6366

64-
1. 更新上游仓库
67+
更新上游仓库
6568

66-
```
67-
git pull --rebase <name> <branch>
68-
//等同于以下两条命令
69-
git fetch <name> <branch>
70-
git rebase <name>/<branch>
69+
```bash
70+
$ git pull --rebase <name> <branch>
71+
# 等同于以下两条命令
72+
$ git fetch <name> <branch>
73+
$ git rebase <name>/<branch>
7174
```
7275

7376
#### commit 信息提交
7477

75-
`commit`信息请遵循[commit消息约定](./CONTRIBUTING_COMMIT.md),以便可以自动生成`changelogs`。具体格式请参考 commit 文档规范。
78+
commit 信息请遵循[commit消息约定](./CONTRIBUTING_COMMIT.md),以便可以自动生成 `CHANGELOG` 。具体格式请参考 commit 文档规范。
7679

7780

7881

7982
#### 开发调试代码
8083

81-
```
84+
```bash
8285
# Build code
83-
npm run build
86+
$ npm run build
8487

8588
# Watch
86-
npm run watch
89+
$ npm run watch
8790

8891
# Run test cases
89-
npm run test
92+
$ npm run test
9093

9194
# Useage
92-
wepy build # Global wepy you installed by npm
95+
$ wepy build # Global wepy you installed by npm
9396

94-
wepy-dev build # Local wepy you compiled by your local repository
97+
$ wepy-dev build # Local wepy you compiled by your local repository
9598

96-
wepy-debug build # Debug local wepy using node --inspect
97-
```
99+
$ wepy-debug build # Debug local wepy using node --inspect
100+
```

0 commit comments

Comments
 (0)