开发流程规范 - listen-now/listen-now GitHub Wiki

开发流程规范

本项目使用ones来进行项目管理,本文档介绍基本的项目管理操作,具体细节可查看ONES 帮助手册

目前用到的功能主要就是Project项目管理,主要目的是为了规范开发流程,提高开发效率

创建任务 -> 编写代码 -> 代码提交 -> 代码审阅 -> 合并 -> 关闭任务

创建任务

在ones中,缺陷、需求和任务都统一归类为任务,当开发者发现有需要进行开发的任务时,可以在任务页面创建任务

填写相关信息,更多选项按照开发需求进行填写

任务创建后,可以在左上角看到该任务的id号码:

代码提交

开发前会首先fork一个repo到自己的账号下,开发者根据任务进行相关开发,中途遇到的相关问题都可以以评论或者文件的形式记录到这个任务中

对于同一个任务开发时可能会有多个commit,在合并到主repo之前只保留一个commit,命名方式为

 #任务id [特性] 任务描述
 
 例如:
 
 #48 [文档] 添加开发流程规范文档

添加时注意git用户信息写好名字和邮箱信息,提交到远程个人repo后就可以进行pull request了,提交了pull request后,相关负责人根据commit信息查看相关任务并审阅代码,点击合并即可,当commit合并到主分支就可以在任务页面看到提交信息。

保留一个commit的方法

比较常用的方法是git rebase,这里简单介绍一下,例如这里有三个小修改,我们提交到远程分支前需要把commit规范化

这里我们要回退到origin/master之后的一个commit上,输入

git rebase -i origin/master

进入一个vim页面,这里把除了第一行的pick保留,其余pick均改为squash

然后:wq保存退出,进入commit 信息编辑页面,这里就换成规范化的信息,注意这里如果行头是#开头的话就会当做注释处理,解决方法是空一个空格

:wq保存退出后再看commit发现已经合并了,push到远程分支即可

修改git用户信息的方法

进入本地repo目录

vim .git/config

根据自身情况在最后添加:

[user]
         name = <yourname>
         email = <[email protected]>

迭代和分支命名规范

当任务完成到一定数量后,相关负责人会开启新的迭代,各开发者根据需求调整自己的任务到不同的迭代中,每个迭代包含一个版本号,开发时可具体分为alpha版本,beta版本,gamma版本,rc版本和release版本,主repo会创建相应的分支,分支命名规则为:

版本号-版本阶段-feature

如:
1.6.0-alpha-docker

rc版本和release版本可贴标签并发布releases

⚠️ **GitHub.com Fallback** ⚠️