about blog github

08 Dec 2022
git最佳实践

  • 创建不同的环境分支,比如dev,test,prod。一般使用main分支作为开发分支,对默认分支执行相应的保护策略,防止误操作

  • 确保环境分支始终稳定,方便快速构建开发或者测试环境

  • 对新的需求或者修改创建新分支,通过PR合并到相应分支

  • PR中一定要关联相应的issue或者task

  • 提交信息尽量一致,清晰

  • 分支命名遵循一致的规则,比如release-1.0,release-1.1

  • 机密信息不能提交到仓库,比如token

  • 仓库结构遵循相应的规范,比如有相应的README,CONTRIBUTING和LICENSE等

  • 经常push代码,防止本地crash代码丢失

  • 一定要测试或者部署代码后才能提交

  • 多次微小的修改,而不是一次提交大量的修改,不方便后期debug和维护

  • 尽量不要提交二进制文件到仓库

  • 代码merge之前一定要有人review

  • 在本地安装相应的linter工具方便做代码静态分析

  • 设置一些常用快捷键,一键提交(add & commit & push)

:) 未完待续……



LEo at 00:12

about blog github