1
1
# Contributing
2
2
3
- 我们提倡您通过提 issue 和 pull request 方式来促进 WePY 的发展。
3
+ 我们提倡您通过提 issue 和 pull request 方式来促进 WePY 的发展。
4
4
5
-
6
5
7
6
## Acknowledgements
8
7
14
13
15
14
其中特别致谢 dlhandsome 提交的38个 commits, 对 WePY 做出了1,350增加和362处删减(截止02/28/18日)。
16
15
17
- WePy 持续招募贡献者,即使是在 Issues 中回答问题,或者做一些简单的 bugfix ,也会给 WePY 带来很大的帮助。
16
+ WePY 持续招募贡献者,即使是在 issue 中回答问题,或者做一些简单的 bugfix ,也会给 WePY 带来很大的帮助。
18
17
19
- Wepy 已开发近一年,在此感谢所有开发者对于 WePY 的喜欢和支持,希望你能够成为 WePY 的核心贡献者,加入 WePY ,共同打造一个更棒的小程序开发框架!🍾🎉
18
+ WePY 已开发近一年,在此感谢所有开发者对于 WePY 的喜欢和支持,希望你能够成为 WePY 的核心贡献者,加入 WePY ,共同打造一个更棒的小程序开发框架!🍾🎉
20
19
21
20
22
21
23
- ## Issue提交
22
+ ## Issue 提交
24
23
25
24
#### 对于贡献者
26
25
@@ -35,63 +34,67 @@ Wepy 已开发近一年,在此感谢所有开发者对于 WePY 的喜欢和支
35
34
36
35
37
36
38
- ## Pull requests
37
+ ## Pull request
39
38
40
39
我们除了希望听到您的反馈和建议外,我们也希望您接受代码形式的直接帮助,对我们的 GitHub 发出 pull request 请求。
41
40
42
41
以下是具体步骤:
43
42
44
43
#### Fork仓库
45
44
46
- 1 . 将需要参与的项目仓库 fork 到自己的 Github 中;
45
+ 点击 ` Fork ` 按钮, 将需要参与的项目仓库 fork 到自己的 Github 中。
47
46
48
- #### git clone 这个 fork 的项目
47
+ #### Clone 已 fork 项目
49
48
50
- 1 . 将自己的 github 中,找到 fork 下来的项目,git clone 到本地。
49
+ 在自己的 github 中,找到 fork 下来的项目,git clone 到本地。
50
+
51
+ ``` bash
52
+ $ git clone
[email protected] :
< yourname
> /wepy.git
53
+ ```
51
54
52
55
#### 添加 WePY 仓库
53
56
54
- 1 . 接着上一步,在该项目中,执行以下操作,将上游仓库连接到本地仓库,即我们 fork 的地址 :
57
+ 将 fork 源仓库连接到本地仓库 :
55
58
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
60
63
```
61
64
62
65
#### 保持与 WePY 仓库的同步
63
66
64
- 1 . 更新上游仓库
67
+ 更新上游仓库:
65
68
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>
71
74
```
72
75
73
76
#### commit 信息提交
74
77
75
- ` commit ` 信息请遵循[ commit消息约定] ( ./CONTRIBUTING_COMMIT.md ) ,以便可以自动生成` changelogs ` 。具体格式请参考 commit 文档规范。
78
+ commit 信息请遵循[ commit消息约定] ( ./CONTRIBUTING_COMMIT.md ) ,以便可以自动生成 ` CHANGELOG ` 。具体格式请参考 commit 文档规范。
76
79
77
80
78
81
79
82
#### 开发调试代码
80
83
81
- ```
84
+ ``` bash
82
85
# Build code
83
- npm run build
86
+ $ npm run build
84
87
85
88
# Watch
86
- npm run watch
89
+ $ npm run watch
87
90
88
91
# Run test cases
89
- npm run test
92
+ $ npm run test
90
93
91
94
# Useage
92
- wepy build # Global wepy you installed by npm
95
+ $ wepy build # Global wepy you installed by npm
93
96
94
- wepy-dev build # Local wepy you compiled by your local repository
97
+ $ wepy-dev build # Local wepy you compiled by your local repository
95
98
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