拉取请求(PR)是您向我们的其中一个代码库提交补丁的步骤。为了避免任何挫折,您应该在开始开发这些功能之前,**先打开一个问题来讨论任何新功能**。这将防止您在核心团队认为不适合项目范围和目标的功能上浪费时间。
完成功能或错误修复后,就可以发送 PR 了。请务必按照以下步骤操作,以确保您的补丁尽快被合并!
仅修改相关文件
确保您的 PR 专注于单个功能。不要更改项目配置或与您正在处理的主题无关的任何文件。每个主题打开一个单独的 PR。
确保您的代码整洁
查看项目风格指南,确保您的代码符合规范且整洁。删除任何调试行(debuggers
,console.log
)。
确保您对更改进行了单元测试
添加功能?确保您添加单元测试来支持它。
修复错误?确保您添加了重现问题的测试。
确保测试通过
我们所有项目的单元测试都可以通过在项目根目录下键入 npm test
来运行。您可能需要安装诸如 mocha
、grunt
或 gulp
之类的依赖项。
保持提交历史简短且整洁
在一个大型项目中,保持 Git 历史记录的整洁和有序非常重要。这有助于识别错误的原因,并有助于识别最佳修复方法。
保持历史记录整洁意味着每个功能进行一次提交。它还意味着在团队审查后压缩您在分支上进行的每个修复。
您是否想知道为什么保持历史记录整洁很重要?阅读来自 Isaac Schlueter(前 Node.js 负责人)的这篇文章。请记住,Git 是一种编辑器。
描述性
撰写一个有说服力的 PR 描述,以及我们应该合并它的原因。
在代码审查期间保持耐心
保持核心代码的整洁和一致性对我们来说非常重要。这意味着我们在代码审查方面非常严格!
代码审查是提高我们工程师自身能力的最佳方式。不要把审查当作个人攻击:它们是为了保持 Yeoman 的整洁并帮助我们改进。
在此处阅读有关代码审查的更多信息。