diff --git a/README.md b/README.md index 6b9d998..be398ea 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,49 @@ ## 协作规范 +### 协作流程 + +每个参与者将版本库克隆到本地 + +``` +git clone https://bdgit.educoder.net/pqfx375oj/Code-Reading-MiNote.git +``` + +切换到到develop分支 + +``` +git checkout develop +``` + +在本地创建自己的分支 + +``` +git checkout -b your_branch_name (e.g. git checkout -b zjh) +``` + +进行修改后,将修改提交到自己的分支 + +``` +git add . +git commit -m "your commit message" +``` + +提交修改前,拉取develop分支最新代码,解决可能存在的冲突 + +``` +git pull origin develop +``` + +将自己的分支推送到远程仓库 + +``` +git push origin your_branch_name +``` + +**提交pull request**,将个人分支合并到develop分支;由组长进行代码审查,合并代码,并将develop的稳定版本合并到master分支。 + +### 代码阅读规范 + 协作者可将代码阅读记录通过注释的方式添加到源代码中,并标注注释的添加者; 各协作者在doc目录中创建一个命名“xxx_notes.md"的文件,进行自己的阅读记录。