我如何像专业人士一样编写提交

2025-05-27

我如何像专业人士一样编写提交

撰写有效的提交信息是经验丰富的开发人员的标志。遵循约定式提交规范是构建提交信息的典范。它不仅仅是一个指南,更是一条通往更清晰的提交历史的途径,并与语义化版本控制 (SemVer)相协调。

什么是常规提交?

常规提交提供了一个轻量级但功能强大的框架来组织提交信息。通过将变更分为功能、修复和重大变更等不同类型,它为清晰度和一致性树立了黄金标准,并通过将变更分为功能、修复和重大变更等不同类型来与语义化版本控制 (SemVer) 保持一致。

伟大承诺信息的剖析

在进行提交时,请使用常规的提交格式,通常遵循的模式<type>: <description>

提交信息应遵循以下结构:



<type>[optional scope]: <description>
[optional body]
[optional footer(s)]


Enter fullscreen mode Exit fullscreen mode

type:提交类型

scope:代码库中某个部分的简短描述,用括号括起来,后跟一个冒号和一个空格。消息通常使用现在时和祈使语气。

description:代码更改的简短描述

body:对本次提交的详细描述,提供有关更改的更多上下文。
必须在描述后留一个空行。

footer:修复问题#3 //示例
页脚应仅包含有关更改的其他问题参考。

例子:

我为解决问题而做出的承诺。
图片描述



feat(homepage): Add carousel feature to showcase testimonials

Implemented a carousel component on the homepage
Added client testimonials section for improved user engagement

Fixes #12


Enter fullscreen mode Exit fullscreen mode

更多示例:

  • 功能:添加新的评级组件
  • 修复:解决城市搜索功能的问题
  • 文档:使用新的贡献指南更新 README

提交类型

除了经典的fix和之外feat,我们还提供了丰富的提交类型。就像为你的提交披萨选择配料一样:

  • build:与构建过程或工具相关的变化。
  • chore:定期维护或管理任务。
  • ci:更新持续集成设置。
  • docs:与文档相关的更改。
  • style:不影响代码功能的更改(例如格式)。
  • refactor:代码修改但不改变其行为。
  • perf:性能改进。
  • test:添加或修改测试。

你可以使用这些类型根据提交的性质对其进行分类。这有助于保持提交信息的一致性,并有助于更好地组织项目历史记录中的变更。

脚注

有关常规提交的更多信息,请访问常规提交规范

文章来源:https://dev.to/phukon/how-i-write-commits-like-a-pro-340l
PREV
CSS 布局:使用 CSS 制作的流行布局和图案的集合
NEXT
2018 年您必读的科技书籍有哪些?