diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6352e7f0eb..be32e77143 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,70 @@ -EasyScheduler提交代码流程 -===== +* First from the remote repository *https://github.com/analysys/EasyScheduler.git* fork code to your own repository + +* there are three branches in the remote repository currently: + * master normal delivery branch + After the stable version is released, the code for the stable version branch is merged into the master branch. + + * dev daily development branch + The daily development branch, the newly submitted code can pull requests to this branch. + + * branch-1.0.0 release version branch + Release version branch, there will be 2.0 ... and other version branches, the version + branch only changes the error, does not add new features. + +* Clone your own warehouse to your local + + `git clone https://github.com/analysys/EasyScheduler.git` + +* Add remote repository address, named upstream + + `git remote add upstream https://github.com/analysys/EasyScheduler.git` + +* View repository: + + `git remote -v` + +> There will be two repositories at this time: origin (your own warehouse) and upstream (remote repository) + +* Get/update remote repository code (already the latest code, skip it) + + `git fetch upstream` + + +* Synchronize remote repository code to local repository + +``` +git checkout origin/dev +git merge --no-ff upstream/dev +``` + +If remote branch has a new branch `DEV-1.0`, you need to synchronize this branch to the local repository. + +``` +git checkout -b dev-1.0 upstream/dev-1.0 +git push --set-upstream origin dev1.0 +``` + +* After modifying the code locally, submit it to your own repository: + +`git commit -m 'test commit'` +`git push` + +* Submit changes to the remote repository + +* On the github page, click on the new pull request. +
+
+ p>
+
+* Select the modified local branch and the branch to merge past to create a pull request.
+
+
+ p>
+
+* Next, the administrator is responsible for **merging** to complete the pull request
+
+---
+
* 首先从远端仓库*https://github.com/analysys/EasyScheduler.git* fork一份代码到自己的仓库中
* 远端仓库中目前有三个分支:
@@ -14,7 +79,7 @@ EasyScheduler提交代码流程
* 把自己仓库clone到本地
- `git clone https://github.com/**/EasyScheduler.git`
+ `git clone https://github.com/analysys/EasyScheduler.git`
* 添加远端仓库地址,命名为upstream
@@ -26,17 +91,10 @@ EasyScheduler提交代码流程
> 此时会有两个仓库:origin(自己的仓库)和upstream(远端仓库)
-* 获取远端仓库代码(已经是最新代码,就跳过)
+* 获取/更新远端仓库代码(已经是最新代码,就跳过)
`git fetch upstream `
-* 更新远端仓库代码
-
-```
-git checkout upstream/dev
-
-git pull upstream dev
-```
* 同步远端仓库代码到本地仓库
@@ -54,7 +112,7 @@ git push --set-upstream origin dev1.0
* 在本地修改代码以后,提交到自己仓库:
- `git ca -m 'test commit'`
+ `git commit -m 'test commit'`
`git push`
* 将修改提交到远端仓库
@@ -68,6 +126,15 @@ git push --set-upstream origin dev1.0