通过 5 个习惯改进 Pull Request
1. 用动词开始你的信息
探究 git 历史记录总是一件苦差事。
你可以用清晰有力的信息来简化这项工作。
从动词开始,
尽量简短。
Fix e2e login spec
Add inactive person styling
Remove presence validation from age on Person model
Decrease TTI on dashboard by 10%
2. 用命令式风格撰写信息
- Fixed nav jitter
+ Fix nav jitter
- Added CTAButton
+ Add CTAButton
在 Stack Overflow 上阅读“我应该在 git 提交消息中使用过去时还是现在时”
3. 用于have/need/get
描述您的 PR
将您的描述分为 3 个逻辑部分:
过去(拥有)、现在(需要)和未来(得到)。
有
描述现有内容。
展现对代码、团队以及创建代码的限制的同理心。
不要对过去吹毛求疵。
需要
描述人性化的需求。
这是客户获得的价值。
暂时不要深入讨论技术细节。
你可以从 Trello/Jira 复制/粘贴。
得到
你不可能总是得到你想要的东西
米克·贾格尔说得对。
用技术术语描述你的解决方案。
承认不足之处。
指出哪些地方你缺乏足够的信息来制定更好的解决方案。
奖励:参考
提供有助于您形成解决方案的支持页面、文档和口头说明的链接。
并注明对您提供帮助的同事。
这能让审阅者深入了解您的流程,并提高您的可信度。
4. 使用--fixup
flag 提交修复
一旦开始审核,诸如fix
、、oops
之类的无用消息shit...
就会开始堆积。
使用--fixup
标志使这些提交更具描述性。
git commit --fixup a1b2c4
Github 有一个确认压缩和合并选项,它会将所有fixup!
提交压缩到它们引用的提交中。
在 thoughtbot 的博客上阅读自动压缩 Git 提交
5. 检查你的自我
记住,你发起的是“拉取请求”,而不是“拉取需求”。
拉取请求是对话的开始。
不要想当然地认为你已经把所有事情都做对了。
要乐于接受反馈。
你可能会学到一些你以前不知道的东西。
玩得开心🥳
告诉我你学到了什么🙌
✅美妙的
鏂囩珷鏉ユ簮锛�https://dev.to/chantastic/improve-pull-requests-with-5-practices-1ke9