git .git目录提交
我正在撰写一篇文章,概述了如何编写良好的Git提交消息,以及开发人员应遵循的各种Git提交消息约定和规则。 但是,正如我写的开发人员应遵循的最佳做法,我不断地发现自己在哪些开发商不应该做一个内部讨论。
我希望原始文章包含最佳实践列表,而不是不要做的事情。 因此,我从中删除了Git commit 最坏实践部分,并决定在此处列出。
Git提交反模式
是什么使Git提交错误消息? 开发人员不应该做哪些事情? 这是我的十大清单:
- 主题行中的字符数不得超过50个。 简洁地描述任何Git提交应该很容易。
- 注释提交时,请勿使用被动语态或过去式。 始终使用主动语音。
- 不要在主题行中添加不必要的大写字母。 除了大写的标准规则,仅将主题行中第一个单词的首字母大写。 绝对不要大声喊叫,不要大声疾呼,更不要说SCREAMING_SNAKE_CASE。 另外,不要在主题行的末尾加上句号。
- 不要尝试使用多余的星号,“&”号和井号标记来格式化提交消息 。
- 不要忘记,有人进行故障排除可能会使用无法自动执行文本换行的Unix实用程序。 取而代之的是,在正文中及其周围的70个字符标记处添加回车符。
- 不要描述您编写的低级代码。 如果有人想查看您编写的代码, 他们将执行git diff 。 提交消息应该描述上下文和目的,而不是实现。
- 不要忘记用完整的回车符分隔提交正文和主题行。
- 不要在提交中简单地引用JIRA票证 。 人们不必打开错误跟踪工具即可知道为什么要对代码库进行更改 。
- 即使您不推动分支机构,也不要对团队的其他成员说些讨厌的话。 本地提交趋向于意外地使其成为中央代码库。 “ 我的白痴团队的领导使我做到了这一点 ” 这一主题行在您的年度审核中可能不会顺利进行。
- 不要在提交内容中进行任何恶作剧。 无论您的散文多么出色,TAGRI规则始终适用于软件开发领域。
是什么让您的Git山羊?
这是我看到的其他开发人员犯下的十大Git提交错误列表,但这绝不是完整的摘要。 作为开发人员, 开发人员如何使用Git确实能使您满意呢? 我想听听其他开发人员在该领域看到的内容,因此请在评论中分享您的Git提交恐怖故事。
git .git目录提交