Git

符合Angular规范的Commit Message <type>[(optional scope)]: <description> // 空行 [optional body] // 空行 [optional footers] 分为了Header、Body、footer三个部分 Header Header部分只有一行<type>[(optional scope)]: <description>，其中type必选，其它可选 type–>归为两类： Development(项目管理类变更，不影响用户和生产环境的代码) Production(影响用户和生产环境的代码) 类型 类别 说明 feat Production 新增功能 fix Production 修复缺陷 perf Production 提高代码性能的变更 style Development 代码格式类的变更，例如使用gofmt格式化代码 refactor Production 其他代码类的变更，例如 简化代码、重命名变量、删除冗余代码等等 test Development 新增测试用例或更新现有的测试用例 ci Development 持续基础和部署相关的改动，例如修改Jenkins、GitLab CI等Ci配置文件或者更新系统单元文件 docs Development 文档类的更新，包括修改用户文档、开发文档 chore Development 其他类型，例如构建流程、依赖管理或者复制工具的变动 scope–>不设置太具体的值，说明commit的影响范围 description–>对commit的简短描述，以动词开头 Body Body对Commit Message的高度概况，方便查看具体做了什么变更 Footer Footer部分不是必选，可根据需要选择，主要用来说什么本次commit导致的后果，通常用来说明不兼容的改动或者关闭的issue BREAKING CHANGE: <breaking change summary> // 空行 <breaking change description + migration instructions> // 空行 // 空行 Fixes(Closes) #<issue number> Revert Commit 特殊的Commit Message。还原了先前的commit，则以revert开头，后面跟还原的commit的Header， 在Body必须写This reverts commit <hash>，其中hash为要还原的commit的SHA标识 ...

Git 仓库 README # 项目名称 <!-- 写一段简短的话描述项目 --> ## 功能特性 <!-- 描述该项目的核心功能点 --> ## 软件架构(可选) <!-- 可以描述下项目的架构 --> ## 快速开始 ### 依赖检查 <!-- 描述该项目的依赖，比如依赖的包、工具或者其他任何依赖项 --> ### 构建 <!-- 描述如何构建该项目 --> ### 运行 <!-- 描述如何运行该项目 --> ## 使用指南 <!-- 描述如何使用该项目 --> ## 如何贡献 <!-- 告诉其他开发者如果给该项目贡献源码 --> ## 社区(可选) <!-- 如果有需要可以介绍一些社区相关的内容 --> ## 关于作者 <!-- 这里写上项目作者 --> ## 谁在用(可选) <!-- 可以列出使用本项目的其他有影响力的项目，算是给项目打个广告吧 --> ## 许可证 <!-- 这里链接上该项目的开源许可证 -->