git-commit-instructions.md
项目根目录下放置:.github/git-commit-instructions.md
在 GitHub Copilot 中,git-commit-instructions.md 文件有以下重要作用:
作为上下文提示
GitHub Copilot 会读取项目中的文档文件作为上下文
当你在提交代码时,Copilot 能理解项目的提交规范
自动建议符合规范的提交信息
智能提交信息生成
当你在 IDEA 或其他编辑器中准备提交时
Copilot 会根据你的代码变更和项目规范
自动生成符合格式的中文提交信息
代码审查辅助
在 Pull Request 中,Copilot 能根据规范检查提交信息质量
提醒是否符合团队约定的格式要求
建议更好的提交信息描述
团队协作增强
新团队成员使用 Copilot 时,会自动遵循项目规范
减少学习成本,提高一致性
避免因不了解规范而写出不合格的提交信息
# Git 提交规范
## 格式
```
<类型>(<作用域>): <描述>
```
## 类型
- `feat`: 新功能
- `fix`: 修复 Bug
- `docs`: 文档变更
- `style`: 代码格式化
- `refactor`: 重构
- `perf`: 性能优化
- `test`: 测试相关
- `chore`: 构建/工具变更
## 示例
```
feat(Login): 新增微信登录功能
fix(Database): 解决数据库连接超时问题
docs(API): 添加用户管理接口文档
refactor(Service): 优化用户服务代码结构
```
## 要求
- 使用中文描述
- 如果一次提交多个功能,多条功能描述换行隔开。
- 描述要具体明确。
特殊说明:
上述文章均是作者实际操作后产出。烦请各位,请勿直接盗用!转载记得标注原文链接:www.zanglikun.com
第三方平台不会及时更新本文最新内容。如果发现本文资料不全,可访问本人的Java博客搜索:标题关键字。以获取最新全部资料 ❤
免责声明: 本站文章旨在总结学习互联网技术过程中的经验与见解。任何人不得将其用于违法或违规活动!所有违规内容均由个人自行承担,与作者无关。
第三方平台不会及时更新本文最新内容。如果发现本文资料不全,可访问本人的Java博客搜索:标题关键字。以获取最新全部资料 ❤
免责声明: 本站文章旨在总结学习互联网技术过程中的经验与见解。任何人不得将其用于违法或违规活动!所有违规内容均由个人自行承担,与作者无关。
