git提交规范

example

Git 提交的标准格式通常包括以下内容:

<type>: <subject>

<body>

<footer>

其中,type 指定提交的类型,subject 是一个简短的描述,body 是一个详细的描述,footer 包括一些元数据,例如参考文献、相关问题等。下面是各种情况下的示例:

添加类:

feat: add MyClass

Add a new class MyClass to implement some functionality.

添加方法:

feat: add my_method to MyClass

Add a new method my_method to MyClass to implement some functionality.

修复 bug:

fix: fix issue with MyClass

Fix a bug in MyClass that caused some unexpected behavior.

文档更新:

docs: update README

Update the README file to provide more information about the project.

样式和格式:

style: fix formatting in MyClass

Fix some formatting issues in the MyClass source code to improve readability.

代码重构:

refactor: move some functionality from MyClass to MyOtherClass

Move some functionality from MyClass to a new class MyOtherClass to better organize the code.

测试更新:

test: add tests for MyClass

Add some unit tests for MyClass to ensure its functionality is correct.

添加依赖:

build: add dependency on numpy

Add numpy as a new dependency to the project to support some new functionality.

删除文件:

chore: remove obsolete file

Remove an obsolete file that is no longer needed in the project.

feat和chore

在 Git 提交的标准格式中,feat 表示“feature”(功能),chore 表示“chore”(杂项任务)。

feat:通常用于描述添加新功能、新功能模块或新功能的提交。例如,添加新功能、新类、新方法等。

chore:通常用于描述其他不属于新功能、修复错误或重构代码的提交。例如,更新文档、清理代码、更新依赖项、删除文件等。

请注意,这只是一种通用的惯例,您可以根据您的项目需求进行自定义。例如,您的团队可能决定使用 enhancement 代替 feat,或者使用 maintenance 代替 chore。重要的是保持一致性并清晰地描述您的提交,以便团队成员和其他开发人员可以方便地了解您的工作。

你可能感兴趣的:(git)