首页 实用干货 🌋

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

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

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

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

"FEAT: Add new login functionality."

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

"FIX: Fix bug causing crashes on certain devices."

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

"STYLE: Update indentation in main.js."

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

"REFACTOR: Refactor the code to improve readability."

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

"TEST: Add new unit tests for login functionality."

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

"CHORE: Update dependencies in package.json."

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

"PERF: Optimize image loading for faster performance."

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

"CI: Fix issue with test pipeline on Dashboard CI."

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

"BUILD: Add new script for building the production version of the app."

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



文章评论

未显示?请点击刷新