GIT提交注释规范
大厂如BAT(百度、阿里巴巴、腾讯)通常会制定自己的 Git 提交规范,这些规范有助于保持代码库的清晰性、可维护性,同时有助于自动化工具的集成,比如自动生成版本日志、自动化测试等。
以下是一些常见的 Git 提交规范标签及其含义,这些标签通常使用 Angular 团队的规范作为基础,不同公司可能会有一些定制化的修改:
-
feat: 新增功能(feature)
git commit -m "feat: add new feature X"
-
fix: 修复 bug
git commit -m "fix: resolve issue with Y"
-
docs: 更新文档
git commit -m "docs: update README"
-
style: 代码风格的变化,不影响代码逻辑
git commit -m "style: format code according to style guide"
-
refactor: 代码重构,不是新增功能也不是修复 bug 的代码变动,可以是注释的调整 log:
git commit -m "refactor: improve variable naming"
-
test: 添加或修改测试代码
git commit -m "test: add unit tests for component X"
-
chore: 对构建过程或辅助工具和库的更改
git commit -m "chore: upgrade dependencies"
-
ci: 对 CI 配置文件和脚本的更改
git commit -m "ci: configure Travis to run tests"
-
perf: 提高性能的代码更改
git commit -m "perf: optimize algorithm for faster processing"
这只是一个基本的示例,实际上,不同公司和团队可能会有不同的规范,也可能会根据实际需要添加一些特定的标签。建议查阅公司或团队的具体文档以获取最准确的信息。
https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
本文作者:Journey&Flower
本文链接:https://www.cnblogs.com/JourneyOfFlower/p/17769176.html
版权声明:本作品采用知识共享署名-非商业性使用-禁止演绎 2.5 中国大陆许可协议进行许可。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步