【前端规范】约定式提交

最新推荐文章于 2024-09-25 08:00:00 发布
最新推荐文章于 2024-09-25 08:00:00 发布
阅读量661 收藏 2
点赞数
分类专栏： 前端 文章标签： git javascript 代码规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/keliq/article/details/112314791
版权
本文介绍了约定式提交的概念，它遵循一套简单的规则，源自Angular提交规范，包括header、body和footer三部分。通过约定式提交，可以自动化生成CHANGELOG，基于提交类型决定版本变更，清晰地传达代码变动，并简化提交历史。文章还详细说明了如何在项目中落地实施，包括使用commitlint和husky防止乱写提交，交互式创建提交消息，以及自动生成changelog。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

「约定大于配置」 的思想在软件工程领域得到了广泛的应用，例如 Spring、Angular 等大型项目。其目的只有一个：减少软件开发人员做决定的数量，提升开发效率。这种思想同样被应用到 Git 提交当中，即 「约定式提交」。

什么是约定式提交？

约定式提交规范是一种基于提交消息的轻量级约定。所谓轻量级约定，说白了，就是有一套用于创建提交消息的简单规则，这套规则源自于Angular 提交规范，规定了提交消息的整体结构：

<type>(<scope>): <short summary>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

翻译成中文就是：

<提交类型>(<作用域>): <简要描述>
// 空一行
<正文>
// 空一行
<脚注>

header 部分

  1. 第一行是 header 部分，必须使用类型字段前缀，它由一个名词组成，只能是下面几种之一：

    • feat: 新功能
    • fix: 修复bug
    • docs：只改动了文档
    • style：修改代码格式（例如去掉空格、改变缩进、增删分号，不影响代码逻辑）
    • refactor：重构代码（理论上不影响现有功能）
    • perf：提升性能的改动
    • test：增加修改测试用例
    • chore：改变构建流程、或者增加依赖库、工具等
    • revert：回滚到上一个版本
    • ci：持续集成
    • build：构建版本

  2. 其后接一个可选的作用域字段，作用域必须是一个描述某部分代码的名词，并用圆括号包围，例如

最低0.47元/天 解锁文章
git约定式提交
花开富贵的博客
12-02 832
约定式提交1.概述2.示例2.1.包含了描述以及正文内有破坏性变更的提交说明2.2.包含了可选的 `!` 字符以提醒注意破坏性变更的提交说明2.3.不包含正文的提交说明2.4.包含作用域的提交说明2.5.为 fix 编写的提交说明，包含（可选的） issue 编号3.※※※ **约定式提交规范** ※※※4.为什么使用约定式提交5.FAQ5.1.在初始开发阶段我该如何处理提交说明？5.2.提交标题中的类型是大写还是小写?5.3.如果提交符合多种类型我该如何操作？5.4.这不会阻碍快速开发和迭代吗？5.5.约
【前端】代码Git提交规范之约定式提交和Commitizen简化提交流程
Yong.Sunshine
09-01 906
在我们目前的前端项目中，我们采用git作为版本控制工具。使用git管理项目意味着我们经常需要提交代码。当我们执行命令时，我们被要求提供一个描述信息。然而，由于每个人的理解和表达方式不同，提交信息的多样性有时会导致信息的模糊和不明确。这不仅影响了代码的可追溯性，还可能隐藏潜在的风险。因此，为了提高团队的协作效率和代码质量，我们需要建立一套统一的提交规范，确保每次提交的信息都是清晰、一致且具有描述性的。那么该怎么规范呢？
约定式提交
weixin_30692143的博客
03-18 118
主要是对提交代码时的提交信息做约定 类型： fix: 修复bug feat:新增功能 BREAKING CHANGE:破坏性变更 其他情况：推荐用 improvement：对当前实现进行改进，没有新增功能或者修复bug 约定式提交 链接 转载于:https://www.cnblogs.com/Running00/p/10554344.html...
git约定式提交规范
wjswangjinsheng的博客
05-15 994
一.Commitizen助你规范化提交代码 commitizen 仓库名为 cz-cli ，它提供了一个 git cz 的指令用于代替 git commit，简单一句话介绍它： 当你使用 commitizen 进行代码提交（git commit）时，commitizen 会提交你在提交时填写所有必需的提交字段！ 全局安装Commitizen npm install -g commitizen@4.2.4 全局安装Commitizen npm i cz-customizable@6.3.0 --s
约定式提交 commit 规范
cdx1170776994的博客
03-15 1541
├── public├── src└── .cz-config.js // 创建是一个可以在 Git hooks 中使用的 npm 包，它可以帮助你在特定的 Git 事件发生时执行命令，例如提交代码之前进行代码格式化、测试等操作."husky"是一个为了方便使用Git hooks的工具，它能够帮助你在项目中自动化地执行一些Git相关的操作。使用husky，你可以在Git的一些关键操作（例如提交、推送、合并等）前或后，执行一些脚本或命令，比如代码格式化、自动化测试、打包发布等。
前端git约定式规范化提交-commitizen
程序猿的傻白甜
06-29 697
当使用commitizen进行代码提交时，commitizen会提示你在提交代码时填写所必填的提交字段信息内容。
阿里前端开发规范（word文档）
04-08
阿里前端开发规范是阿里巴巴集团为前端工程师制定的一套详尽的工作指南，旨在提高代码质量、提升团队协作效率、保持代码一致性。这套规范涵盖了HTML、CSS、JavaScript、工程化、性能优化等多个方面，对于任何前端...
Vue前端开发规范整理(推荐)
08-27
Vue 前端开发规范整理 Vue 前端开发规范是基于 Vue 官方风格指南整理的关于 Vue 前端开发的规范，这些规范对于提高代码质量和维护性非常重要。本文将对这些规范进行详细的解释和说明。 组件名 组件名应该始终是...
【Git】Conventional Commit 约定式提交规范
雨下一整晚real的博客
05-21 2193
定义 在 git 代码提交的时候，我们需要对 git 的提交信息做出一定的约定或者规范。为什么会有这样的需求？因为 git 提交时的描述信息，需要在你的合作开发者之间共享，所以大多数情况下 git 提交信息并不只能被你一个人明白。于是就诞生了约定式提交这样的规范。 业内普遍认可的的约定式提交规范，为 约定式提交 (Conventional Commits)。 约定式提交规范 Conventional Commits 是一种用于给提交信息增加人机可读含义的规范，是基于提交信息的轻量级约定，提供了一组用于创建清
2023 年了，还有前端人不知道 commit 规范 ？
程序员成长指北
04-04 222
大厂技术高级前端Node进阶点击上方程序员成长指北，关注公众号 回复1，加入高级Node交流群一个开发人员需要知道的 commit 规范什么是约定式提交约定式提交（Conventional Commits）是一种用于代码版本控制的规范，旨在通过明确和标准化提交信息来提高代码协作质量和效率。其基本原则是通过规定提交信息的结构和语义来提高代码版本控制的可读性、可维护性和自动化程度。约定式提交...
Git 约定式提交
qq_43082721的博客
12-24 1001
概述 每次提交代码的时候，我们都需要为我们本次修改的内容添加一段描述，例如： git commit -m "Initial commit"; git commit -m "修复了一些已知问题。"; git commit -m "增加了新特性。"; 但实际上有些 commit message 千奇百怪，比如以下这种： 一次 commit 应该准确的说明本次提交的目的和修改内容，比如： git commit -m "chore: upgrade org.bouncycastle:bcprov-jdk15on
【规范】Git Commit 约定式提交规范
杜小舟的博客
09-12 1209
约定式提交规范它是一种基于提交信息的轻量级约定，提供了一组简单规则来创建清晰的提交历史。
你还没用过“约定式提交”吗？那你赶紧来补补知识吧
LarsCheng's Blog
11-12 1951
前言 本文为介绍约定式提交，主要从以下几点展开： 现状分析 约定式提交 优点 规范 commitizen standard-version 本文对应的github项目地址：https://github.com/larscheng/Conventional-Commits-Demo 现状分析 目前我们的项目在commit时基本上五花八门，各领风骚。虽然不如网上的那些恶搞commit记录...
前端代码规范- Commit 提交规范
zhudapeng929的博客
09-09 2573
约定式提交（Conventional Commits）是一种用于代码版本控制的规范，旨在通过明确和标准化提交信息来提高代码协作质量和效率。其基本原则是通过规定提交信息的结构和语义来提高代码版本控制的可读性、可维护性和自动化程度。约定式提交规范通常要求提交信息包括一个描述性的"类型"、一个可选的"作用域"、一个用于简洁说明的"主题"，以及可选的"正文"和"尾部"等组成部分。
git commit规范提交
酒无忧的博客
11-06 1788
Git每次提交代码时，都要写Commit Message（提交说明），通常情况下，Commit Message应该清晰明了，说明本次提交的目的和具体操作等。例如，有些人会写此次代码的修改是基于哪个模块，有些人会写解决了哪些Bug，有些则只写修改了哪个文件，中英文混用等等五花八门的Commit格式，这导致后续的代码维护成本很高，有时候提交人看Commit Message都不知道自己改了什么。比如查阅某个业务的修改历史，查阅某个时间段修复了哪些Bug，因为Commit没有统一的格式，就比较难快速获取这些信息。
什么是约定式提交, 约定式提交的格式, 以及怎么在不同编程语言引入约定式提交(JS,Java,Go,Python)
最新发布
2402_87605821的博客
09-25 1271
约定式提交是一种规范，用于为提交信息添加人类和机器可读的含义。这种标准化格式促进了语义版本控制，简化了变更日志的生成，并通过清楚地传达每个更改的意图和范围来提高协作效率。 提交类型及其用法，以及如何在不同JavaScript, Java, Go, Python中实施
淘宝前端开发 通用约定
宪涛
12-17 326
原文地址：http://kissyteam.github.com/docs/html/styleguide/common-conventions.html   文件与目录命名约定 一律小写，必须是英文单词或产品名称的拼音，多个单词用连字符（-）连接。 只能出现英文字母、数字和连字符，严禁出现中文。 出现版本号时，需要用字母 v 做为前缀，小版本号用点号（.）隔开，比如 g...
maven 项目添加 git-hook 脚本，约束提交内容格式
小单的博客专栏
11-06 1229
在执行maven的 clean 或者 compile 时候，插件会自动输出。目录中的 bash 脚本来做一定的验证工作。git 提交代码，推送代码，可以通过在。
提升团队协作效率的web前端开发规范
**定义：** 开发规范是一种为了确保项目开发的高效性、代码的可维护性以及团队成员之间沟通的一致性而制定的一系列规则和约定。 **目的：** 1. **提高开发效率：** 规范化的开发流程能够减少不必要的沟通成本，提高...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值