git commit message 书写规范

桃扇骨 2024-02-06 04:56 12阅读 0赞

在使用 Git 提交时，遵循良好的提交消息规范可以提高代码的可读性和可维护性。以下是一些常见的 Git 提交消息书写规范：

1.  提交消息格式：一个提交消息通常包含三个部分：标题、空行和正文。它们之间使用空行分隔。
    
        <标题>
        
        <正文>
        ```
2.  标题（Title）：
    
     *  简洁明了：标题应该简明扼要地描述该提交的概要内容。
     *  首字母大写：标题的首字母通常大写。
     *  动词使用一般现在时：使用一般现在时来描述提交所做的更改。例如，使用 "Fix" 而不是 "Fixed"，使用 "Add" 而不是 "Added"。
3.  正文（Body）：
    
     *  可选项：正文是可选的，可以用于提供更详细的信息。
     *  解释性描述：如果标题本身不足以解释提交的更改内容，可以在正文中提供更多的背景、原因、目的等信息。
     *  分段落：对于较长的正文，可以使用适当的分段落来提高可读性。
4.  提交类型（Commit Type）：根据提交的目的和内容，可以使用不同的提交类型标识。常见的提交类型包括但不限于以下几种：
    
     *  `feat`：新增功能（feature）
     *  `fix`：修复问题（bug fix）
     *  `docs`：文档更新
     *  `style`：代码样式调整（不影响代码功能）
     *  `refactor`：重构代码（既不修复错误也不添加功能）
     *  `test`：添加或修改测试代码
     *  `chore`：构建过程或辅助工具的变动
    
    你可以根据具体的项目或团队规范定义自己的提交类型。
5.  提交范围（Commit Scope）：可选项，用于指定提交更改的范围或相关模块。范围应该简洁明了，例如文件名、模块名等。

下面是一个示例提交消息的格式：

feat: Add user registration functionality
    
    - Implement user registration form
    - Validate user input
    - Store user data in database
    
    Fixes #123

在上面的示例中，提交类型为 `feat`（新增功能），标题为 "Add user registration functionality"，正文中提供了一些具体的更改描述。最后，使用 "Fixes \#123" 的格式可以关联提交与特定的问题或任务（这取决于你使用的任务跟踪系统）。

请根据你的实际项目和团队规范来定义适合自己的提交消息书写规范。保持一致和清晰的提交消息可以帮助团队成员更好地理解和追踪代码更改。