Skip to content

Latest commit

 

History

History
60 lines (52 loc) · 2.32 KB

File metadata and controls

60 lines (52 loc) · 2.32 KB

fehead基础建设

绪论 来fehead的时候,fehead是一穷二白,快要走了,发现也是一穷二白,有种什么都没做的感觉 结合实习经历,想整一个fehead开发学习的基建,留点东西下来,让后生可以不断完善,不至于刚进来的时候有种“假大空”的感觉(这是我进fehead几个月后的主观感受) 最重要的是文档和开发流程 文档最重要:记录开发学习的内容,可以是一种总结,此为其一。留下文档可助后生快速入门,减少学习和指导成本,此为其二。来日需要对项目二次开发或者重构追加功能时,提供指导,此为其三。 开发流程次之:规范的开发流程和代码规范,可以提高共同开发的效率和减少阅读代码的难度。

[TOC]

git

搭建git仓库

加入fehead-studio组织

流程规范

创建项目

  1. 团队成员在fehead-studio创建仓库
  2. 开发者fork仓库到个人账号
  3. 开发者clone仓库到本地进行开发

开发规范

  1. clone到本地的仓库默认分支在主分支
  2. 建立新分支,新分支以本次操作命名,如:add_chat_function
  3. 当开发期间团队仓库分支发生更改,并可能与正在开发的任务发生冲突时,切换到master分支,pull新的内容,然后切换回开发分支,使用rebase命令进行处理,具体操作见[git文档](// TODO)

注:不要在本地主分支开发,保证在pull的时候不会发生冲突

commit规范

参考文章

<type>(<change_name>): <message>

eg:

feat(fehead_build): add document

type参照如下:

feat: 新特性
fix: 修改问题
refactor: 代码重构
docs: 文档修改
style: 代码格式修改, 注意不是 css 修改
test: 测试用例修改
chore: 其他修改, 比如构建流程, 依赖管理

合并代码

  1. 开发完后commit代码,然后push到个人仓库
  2. 向主仓库提pull request
  3. 找相关成员进行code review(代码检查)
  4. 检查通过后由管理员合入仓库

文档

github上新建文档仓库

  1. 由管理员在团队账号上新建文档仓库
  2. 文档仓库开放merge权限
  3. 每位成员在团队仓库创建一个个人分支,提交个人的文章
  4. master分支用于提交基础文档