内容简介：git的用户名为自己名字的小写全拼，邮箱为公司邮箱，方便追溯提交者。命令行操作示例：分支管理请参考《Git分支管理规范》。
git的用户名为自己名字的小写全拼，邮箱为公司邮箱，方便追溯提交者。命令行操作示例：
git config --global user.name myname git config --global user.email myemail@example.com
git commit
的log原则：
- 必须说明提交的意义，不能是简单无意义的文字
- bug fix应写上是解决哪个bug，可复制禅道上的ID和标题
- 做需求应写是哪个需求；分批提交应写上完成了什么具体内容
分支管理请参考《Git分支管理规范》。
代码规范
各技术组自己决定代码风格规范，可参考google、apple、facebook、alibaba、airbnb、microsoft任一家的。并可找些自动格式化和检查 工具 作为辅助。例如移动开发可参考 《移动开发代码规范与格式化工具》 。
代码的文件组织（目录结构）规范应在 README.md
中说明。
文档规范
新项目必须画系统架构图、网络拓扑图等宏观设计的图，便于新同学或测试组同学理解。无论在哪里写的，最后都应该复制一份一同提交到代码仓库。
好的代码应该只需要描述宏观架构和设计思路就能让新人上手，细节的设计是通过代码注释和增强代码可读性来体现的。快速的迭代节奏不会有时间写详细设计，且变化太快也来不及更新文档。
README.md
（代码说明）还可以包括这些内容：
- 迭代历史
- TODO list
- 工具使用说明
- 第三方依赖的参考文档URL
- 特殊的设计、约定
- 项目关联的文档地址，例如需求文档、服务器接口文档等
- 各种系统的一些公用的低机密性账号密码
前后端合作都以API为媒介，所以API文档是必须的。怎么设计API规范，可参考 《Web API规范设计指引》 。
Review制度
哪些情况应该主动请求review：
- 有可能破坏了整体的设计风格、规范
- 代码所属的功能非常重要，出错的话会造成公司业务重大损失
- 改动范围很大，会改到另外2个或以上同事写的较多代码
本节参考
本系列文章的目录： https://hursing.blog.csdn.net/article/details/88025790
以上所述就是小编给大家介绍的《项目过程管理（十）开发规范》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持！
猜你喜欢:
本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。
