项目规范

项目规范

分支说明

• master: 主分支
• phaseX: 每期进行中分支，X 为当期期数，每期结束后合并到 master 分支，合并完成后删除

标签说明

• 申请加入：申请加入本项目
• 第 x 期：每一期的标签
• 认领审阅：每期认领审阅文章的标签
• 审阅完成：完成本期审阅
• 完成：根据审阅意见修改完毕，完成本期的作业

Pull Requests 说明

• 每个 pr 的标题明确本次 pr 主要内容
• 每个 pr 提交到主项目明确的对应分支，
• 每期 pr 应该只有一个文件改动

分支管理规范：

1. 本地仓库应该添加两个远程仓库的地址，主项目地址和 fork 仓库的地址
2. 每期的开发分支被合并后，应该 pull 主项目的 phaseX 分支到本地，并 checkout 一个新的分支开发下一期
3. 开发完后 push 该分支到 fork 仓库并提交 pr 到主项目 phaseX 分支

审阅规范：

1. 审阅时间为下一期的第一周，时间宽松，需要保证审阅质量
2. 审阅人员优先认领，认领事标记上认领审阅标签，后续再通过其他方式指定，每篇文章保证有人审阅
3. 文章审阅前先严格检查 pr 提交规范，凡是不符合要求的告知负责人拒掉
4. 基于 pr 进行审阅，在需要修改或者不理解的地方添加评论
5. 审阅完成后，从叙述方式、格式规范、改进建议等角度给出审阅评价

发布规范

1. 文章正文前建议注明本项目的相关信息（不做硬性规定），内容和格式如下

   >- 文章来源：itsCoder 的 [WeeklyBolg](https://github.com/itsCoder/weeklyblog) 项目
   >- itsCoder主页：[http://itscoder.com/](http://itscoder.com/)
   >- 作者：[]()
   >- 审阅者：[]()
   

2. 文章完成审阅之后发布到个人博客 ，并将个人博客上的文章地址更新到 pr 对话中，参照开发规范第 5 条

3. 每期完成后由负责人发布到 itsCoder 主页