Skip to content

Commit 4c16cfc

Browse files
Merge pull request #331 from WeBankPartners/276_contributors_submit_guidelines_new
#276 Code contributors submit guidelines
2 parents cf757fd + 50de300 commit 4c16cfc

8 files changed

Lines changed: 76 additions & 0 deletions

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,10 @@ WeCMDB使用Java和React JS进行开发,数据存储于MySQL,并依赖Tomcat
9494

9595
请参考以下文档进行开发环境配置[WeCMDB开发环境配置](cmdb-wiki/docs/developer/wecmdb_developer_guide.md)
9696

97+
#### WeCMDB代码贡献指引
98+
关于WeCMDB代码贡献, 请查看以下文档
99+
[WeCMDB代码贡献指引手册](cmdb-wiki/docs/developer/code_contributors_submit_guide.md)
100+
97101
## API说明
98102
关于WeCMDB的API说明, 请查看以下文档
99103
[WeCMDB API手册](cmdb-wiki/docs/api/wecmdb_api_guide.md)
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# WeCMDB代码贡献指引
2+
3+
## 步骤
4+
## 1. fork项目
5+
6+
进入we-cmdb仓库,点击右边的fork,fork的含义就是创建we-cmdb项目的副本作为你自已的项目
7+
**点击"fork"**
8+
![commit_fork](images/commit_fork.png)
9+
10+
## 2. 修改代码
11+
12+
fork之后的图如下图所示,从下图可以看出we-cmdb已经处于自已的github帐号库中,同时也可以发现github还标明了该库的来源,因为只有标明了来源,后面你修改了文件才有提交的路径
13+
14+
**我的仓库**
15+
![commit_my_repositories](images/commit_my_repositories.png)
16+
17+
18+
>修改或者增加仓库里的文件,可以选择在线修改,在线修改一般适合修改量较少,这里介绍的是采用Git工具,将代码仓库下载到本地,在本地修改之后再上传上去,相关命令如下:
19+
20+
mkdir myRepositories #创建myRepositories目录
21+
22+
cd myRepositories #切换到myRepositories目录
23+
24+
git init #创建并初始化git库
25+
26+
#增加远程git仓库
27+
28+
git remote add origin https://github.com/xuxuzhesi/we-cmdb.git(自己仓库地址)
29+
30+
#将远程git库下载到本地
31+
32+
git pull origin master
33+
34+
## 3. 提交代码
35+
#### 3.1 在本地编译器修改代码后,接下来要做的就是将修改后的代码库上传上去,命令如下:
36+
37+
#会将当前目录myRepositories下所有文件都增加到本地库中
38+
39+
git add .
40+
41+
#提交更改
42+
43+
git commit -am 'Commit Explanation'
44+
45+
#将库上传到github上
46+
47+
git push -u origin master
48+
49+
> 上传完后,再回到github网站上,可以看到刚才提交的内容:
50+
![commit_commit](images/commit_commit.png)
51+
52+
#### 3.2 将修改提交给主帐号的原作者
53+
>最后就是将修改提交给主帐号的原作者,由它来决定是否合并你的修改,操作如下,点击Compare & Pull request后,跳转到下一个页面
54+
55+
点击 **“New pull Request”**
56+
![commit_new_pull_request](images/commit_new_pull_request.png)
57+
58+
>主帐号里的源作者即可收到你的提交请求,如果觉的可以的话,就会将你的请求同主干合并
59+
60+
## 4. 保持与原作者同步
61+
在同步的过程中,你会看到别人每次提交的更改,这也是Github最大的价值之一,保持与原作者同步首先要做的就是再次点击pull
62+
63+
request,修改源分支和目标分支,发送一个pull request。
64+
65+
![commit_new_pull_request_3](images/commit_new_pull_request_3.png)
66+
67+
![commit_new_pull_request_2](images/commit_new_pull_request_2.png)
68+
69+
70+
71+
72+
### End
50.3 KB
Loading
33.3 KB
Loading
7.72 KB
Loading
106 KB
Loading
11.6 KB
Loading
7.81 KB
Loading

0 commit comments

Comments
 (0)