前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >掌握编写有效的GitHub提交信息的艺术

掌握编写有效的GitHub提交信息的艺术

作者头像
前端小智@大迁世界
发布2023-03-01 16:10:42
1660
发布2023-03-01 16:10:42
举报
文章被收录于专栏:终身学习者终身学习者

更多开源作品请看 GitHub https://github.com/qq449245884/xiaozhi ,包含一线大厂面试完整考点、资料以及我的系列文章。

写提交信息没有严格的规则,但当在GitHub上做项目时,清楚、简洁地传达你所做的修改是很重要的。做到这一点的方法之一是在提交信息中使用关键字。

这些关键词,或标签,有助于表明变化的性质,使其他人更容易理解你的贡献的背景。

以下是一些常见的关键词和它们所表示的内容。

FEAT:使用这个关键词来表示你正在致力于一项新的功能。

代码语言:javascript
复制
"FEAT: Add new login functionality."

FIX:使用这个关键词表示你正在对一个特定的问题或议题进行修复。

代码语言:javascript
复制
"FIX: Fix bug causing crashes on certain devices."

STYLE: 使用这个关键词表示你正在对代码的风格或格式进行修改,而不是对其功能进行修改。

代码语言:javascript
复制
"STYLE: Update indentation in main.js."

REFACTOR: 使用这个关键词表示你正在对代码进行修改,改善其结构或组织,但不增加新的功能或修复错误。

代码语言:javascript
复制
"REFACTOR: Refactor the code to improve readability."

TEST: 使用这个关键字表示你正在为代码添加或更新测试。

代码语言:javascript
复制
"TEST: Add new unit tests for login functionality."

CHORE:使用这个关键词表示你正在对构建过程或其他与代码本身没有直接关系的任务进行修改。

代码语言:javascript
复制
"CHORE: Update dependencies in package.json."

PERF:使用这个关键词表示你正在进行修改以提高代码的性能。

代码语言:javascript
复制
"PERF: Optimize image loading for faster performance."

CI:使用这个关键词表示你正在对持续集成过程进行修改。

代码语言:javascript
复制
"CI: Fix issue with test pipeline on Dashboard CI."

BUILD:使用这个关键词表示你正在对构建过程进行修改。

代码语言:javascript
复制
"BUILD: Add new script for building the production version of the app."

通过在你的提交信息中使用这些关键词,可以帮助使你的贡献更清晰,更容易被他人理解。然而,需要注意的是,这些只是建议,并不是所有的项目都使用这些建议,如果团队有自己的规范,那么应该按自己的规范走。

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2023-02-03,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
持续集成
CODING 持续集成(CODING Continuous Integration,CODING-CI)全面兼容 Jenkins 的持续集成服务,支持 Java、Python、NodeJS 等所有主流语言,并且支持 Docker 镜像的构建。图形化编排,高配集群多 Job 并行构建全面提速您的构建任务。支持主流的 Git 代码仓库,包括 CODING 代码托管、GitHub、GitLab 等。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档