diff --git a/README.md b/README.md index 1406d56..5d84d2b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,73 @@ # CodeReading-MiNote 这里主要存放代码资源 -简单对每一名同志的注释情况做了简要记录 \ No newline at end of file +简单对每一名同志的注释情况做了简要记录 + +# Code-Reading-MiNote + +## 说明 + +此项目为“开源软件阅读标注”小组作业,小组成员为程星桦、张晋菡、张鹏展、文渤乔 + +阅读项目为[MiCode便签-小米便签的社区开源版](https://github.com/MiCode/Notes) + +具体环境部署和测试在本地进行 + + +## 协作规范 + +### 协作流程 + +每个参与者将版本库克隆到本地 + +``` +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"的文件,进行自己的阅读记录。 + +具体分工待定。 + + +## 参考资料(小组成员可另行补充) + +[源码以及阅读报告](https://gitee.com/mi-note-development-team/minote/tree/master/) + +[知识荟-过往讨论](https://www.learnerhub.net/#/spaces/146/search?text=%E5%B0%8F%E7%B1%B3%E4%BE%BF%E7%AD%BE&t=1729487479088&type=docs):有许多往届关于小米便签的阅读讨论帖,有很强的参考价值 \ No newline at end of file