代码审查文件

Question

在一个项目中，我们有一个相当正式的代码评审，它目前是手动完成的，并记录在Excel表和Word文档中。

我们希望通过将它集成到一个Git工作流中来改进当前的代码评审过程(使用像Bitbucket Server这样的工具，我们已经有了，Gerrit等等)。

当前的想法是，每个开发人员实现特性和错误，并创建一个拉请求。这个拉请求由其他开发人员审核，然后合并到我们的主要开发分支中。

我们希望导出所有的拉请求(现在是代码评审)，以便将它们正式记录在脱机文档中。此代码评审文档是我们客户的交付项。

这是否一个可行的方法？

Answer 1

你可以看看Phabricator。它是一个很好的全一体化软件项目管理应用程序，它处理类似于您描述的代码评审，并且在软件开发方面做了更多的工作。

我不想向您推荐一个工具，但我想向您展示他们对代码审查有什么想法，我认为这是可靠和可行的。

Phabricator中的整个开发过程都有文档记录，不仅仅是代码审查，因为它通过使用标识符将所有信息连接起来，这些标识符会自动转换为链接，并生成包含操作中的日期、时间和用户的引用。

下面是Phabricator中的代码评审(更具体地解决您的问题)：

1. 开发人员在本地git存储库中创建一个新分支，并对其更改进行提交。
2. 开发人员启动arc diff来链接和测试更改，并创建代码评审(称为“差异”)。此时可以添加一些元数据。
3. Phabricator接收到差异，并将其提供给该项目的其他开发人员。
4. 其他开发人员可以注释变更集并对其进行注释。作者可以对微分进行更新。
5. 审阅者可以接受或拒绝差异。
6. 然后，作者可以放弃差异或提交它(arc land)。
7. 存储库接收提交，并自动将其与差异连接。并且差异还与提交和/或导致结果的操作连接在一起。

Phabricator的开发非常迅速，而且它本身也开发了在Phabricator的公共实例中。

Answer 2

Bitbucket服务器当然可以做到这一点，它有用于提取拉请求数据的休息 )。如果您希望产品中有更具体的内容，那么插件SDK可以自动生成文档。

正如其他人所建议的那样，这可能是一个很好的时机，可以回顾您的客户需要什么(或认为他们需要)以及其他可以捕获和交付的方式。这可能是因为你已经在寻找最好的选择，但可能有更精简的选择，节省你和他们的时间/金钱。

信息披露:我为亚特兰西安工作