git提交commit规范

Git提交commit规范可以帮助我们在提交代码时更加规范、清晰地记录每次提交的目的和内容。常见的git提交commit规范有以下几种：

1. 使用约定的提交消息格式：一般使用"[类型]: 提交说明"的格式，其中类型可以是feat（新功能）、fix（修复bug）、docs（文档修改）、style（代码格式修改）、refactor（代码重构）、test（测试代码修改）等。
例如：feat: 添加用户注册功能

2. 提交消息的内容要简明扼要，清晰明了，用一句话描述本次提交的目的和内容。

3. 可以在提交消息中添加关联的issue编号，方便跟踪和查看。

4. 提交消息的第一行要尽量控制在50个字符以内，更详细的说明可以在第一行后面进行补充。

5. 可以使用一些常用的提交类型和动词，如feat（添加）、fix（修复）、docs（文档）、style（代码样式）、refactor（重构）、test（测试）、chore（构建/工具/其他）等。

请注意，git提交commit规范可以根据团队的实际情况和需求进行调整和扩展，重要的是保持一致性和清晰性。

相关问题

git修改commit提交规范

### 修改Git Commit消息的最佳实践

当需要修正最近一次提交的消息时，`git commit --amend`命令提供了便捷的方法来更新最后一条提交的信息。这不仅有助于保持清晰的历史记录，还能够确保团队成员之间的沟通顺畅[^1]。

对于已经创建但尚未推送到远程仓库的提交，可以通过执行如下命令来进行修改：

git commit --amend -m "新的提交说明"

上述命令会替换掉最后一次提交的信息为新指定的内容。如果希望使用默认编辑器打开并手动调整，则省略 `-m` 参数即可：

git commit --amend

需要注意的是，在多人协作环境中，一旦提交被推送至共享分支之后再做此类改动可能会引起冲突或其他问题。因此建议仅对本地未分享过的提交应用此操作。

为了使更改生效并且不影响其他开发者的工作流程，在完成commit message 的修改后还需要强制推送这些变化到远端服务器上（假设该提交还未被他人拉取）:

git push --force-with-lease origin 主分支名称

这里 `--force-with-lease` 是一种更安全的方式来做强制推送，它会在覆盖之前检查是否有新的提交加入到了目标分支中，从而减少意外丢失工作的风险。

通过遵循以上指导原则，可以有效地管理项目历史记录中的提交信息，提高代码库的质量和可维护性的同时也促进了良好的合作习惯。

git commit 提交规范举例

### Git Commit Message 规范示例

#### 单行提交信息格式
每次提交应当只解决一个问题，这有助于简化代码审查过程并提高可追溯性。单行提交信息应该简洁明了，通常不超过72个字符[^1]。

type(scope): subject

- `type` 表示更改的性质（如 feat, fix）
- `scope` 是可选字段，用于指定受影响的部分或模块名称
- `subject` 描述所做的改动摘要

#### 完整多行提交信息结构
对于更复杂的变更，则推荐采用如下完整的多行格式：

type(scope): subject

Body explaining the change and its motivation.

Footer with any relevant issue references.

其中：
- **Header**: 包含三部分——类型(type)，作用域(scope)以及主题(subject)
- **Body**: 对修改原因及实现细节做进一步解释说明；如果适用的话还可以提及如何测试这些变化。
- **Footer**: 如果有的话，在这里注明关联的问题编号或者其他元数据信息，例如关闭某个GitHub Issues。

#### 实际案例展示

##### 添加新功能的例子
当向项目中引入新的特性时，可以这样书写commit message:

feat(user-profile): add avatar upload feature

Allow users to upload avatars from their local machines or via URL links. This enhancement improves user experience by personalizing profiles.

Closes #1234

##### 修复Bug的例子
针对错误修正类别的提交消息则像下面这样表达:

fix(authentication): resolve login redirect loop on Safari browser

The previous implementation caused an infinite redirection when logging in using Safari due to incorrect handling of session cookies. The solution was implemented according to best practices outlined at MDN Web Docs regarding secure cookie settings.

Fixes #9876

#### 工具支持
为了确保团队成员都能遵循一致的消息格式化规则，建议使用工具辅助验证。例如可以通过配置 pre-commit hook 来运行 validate-commit-msg 或者集成 CI/CD 流程中的检查脚本以自动拒绝不符合规定的提交请求[^3]。