数据科学

使用拉取请求进行协作和代码审查的好处

软件团队由广泛的专业人员组成,从软件工程师、数据科学家到项目经理和技术作家。在处理项目时,与其他团队成员共享代码很常见,跟踪所有更改很重要。这就是拉取请求的来源。

在软件开发中,拉取请求用于将本地更改推送到共享存储库中(图 1 )。这是一种在将批准的更新推送到中央服务器之前向其他合作者请求代码审查的方法。这有助于维护版本控制。

Diagram showing a central repository with many local copies across multiple computers.
图 1.拉取请求用于将本地更改推送到共享存储库

这篇文章讨论了拉请求的好处,并分享了在处理软件项目时创建和处理拉请求的技巧。使用这些信息,您将能够更好地与许多合作者合作进行重大项目。

拉取请求的步骤

要创建拉取请求,请执行以下步骤。

  1. 使用以下命令创建一个新的 git 分支以在本地工作:
    git -b BRANCH_NAME
  2. 使用以下命令实现更改并频繁推送它们(以便它们不会丢失):
    git add NAME_OF_THE_FILE
    git commit -m "DESCRIBE YOUR RECENT CHANGES"
  3. 完成实施并在本地提交更改后,应该从共享存储库中获取最新的更改,以确保没有冲突的更改。您可以使用以下命令获取最新的更改:
    git pull origin BRANCH_NAME
  4. 使用以下命令将更改推送到远程存储库:
    git push --set-upstream-to origin REMOTE_BRANCH_NAME
  5. 导航到共享存储库所在平台的用户界面( GitLab 、 GitHub 、 BitBucket )。在那里,您需要写下拉取请求的名称和简短描述。您还可以选择将其分配给团队中的某个人进行审阅。

有关拉取请求的更详细介绍,请参见 Making a Pull Request

使用拉取请求的主要好处

无论您是在项目的前端还是后端工作,在与团队合作时,拉取请求都有助于代码审查过程。本节详细介绍了在工作中使用 pull 请求的主要好处。

促进协作

当谈到协作时,有一些事情可以造就或破坏团队。其中之一就是能够一起工作,即使成员负责项目的不同部分。

使用拉取请求,可以在不影响其他人工作的情况下进行更改。它们是从团队成员那里收集技巧或代码改进的好方法。

如果您对代码更改不确定,请提交拉取请求以获得反馈。其他团队成员可能有您没有考虑的建议,这可以帮助您更好地决定代码。

在任何项目中,让经验丰富的工程师审查、接受或拒绝更改都很重要,因为您可能会错过一些他们可以从新的角度看到的东西。

然而,当多个团队成员向项目代码库提交更改时,避免瓶颈同样重要。对于那些处理拉取请求的人来说,为预期的审查时间设定期望值至关重要。这确保了项目继续向前推进。

更快地构建功能

Pull 请求是一个强大的工具,可以帮助团队更快地构建功能。因为拉取请求可以在添加注释的情况下进行审查,所以它们提供了沟通代码更改的极好方式。

首先,它们使开发人员能够向项目提交更改,而无需等待项目维护人员合并更改。这使团队成员能够并行处理代码更改,从而加快开发速度。

第二,可以审查拉取请求并添加评论。审查拉取请求的开发人员可能需要提出问题或澄清潜在错误。您还可以使用注释共享资源。

第三,可以合并拉取请求,以便在构建新功能时可以快速、轻松地将更改集成到项目中。

减少与添加新代码相关的风险

毫无疑问,编程代码有一定程度的风险。毕竟,每次向代码库添加新内容时,都可能会引入影响最终用户的新 bug 和漏洞。

在拉取请求合并到主代码库之前,其他团队成员有机会审查更改,以确保符合团队的编码标准。 bug 和错误可以在导致实时代码中出现任何问题之前解决。

使用 pull 请求,您可以随时回滚到以前的版本,以防出现问题。拉取请求成为您的安全网。

提高代码质量和性能

当您创建一个拉取请求时,您实际上是在要求其他人审查您的代码并给出反馈。通过让同事参与进来,您可以根据反馈提高代码的质量。

您可以通过在拉取请求的描述部分中编写描述性提交消息和解释来帮助审阅者理解您的更改。

如果你做出了别人不同意的改变,你也可以避免潜在的问题。他们可以简单地对您的拉取请求提出问题。这让您有机会在问题变得更大之前解决问题。这是一种提高代码质量的强大方法。

要点

通过拉取请求维护版本控制对于软件团队来说非常重要。这种方法使团队成员能够在跟踪和管理软件系统更改的同时进行协作。通过使用拉取请求,团队可以同时处理系统的不同部分,然后轻松地将其更改合并在一起。这可以提高团队效率并防止冲突。

如果正确使用,拉取请求提供了一种清晰、简洁的方式来查看对代码或文件所做的更改,从而促进了讨论和反馈。

拉动请求的重要性怎么强调都不为过。它们是软件开发过程的重要组成部分,有助于确保相关方在将代码更改合并到主代码库之前对其进行审查。这有助于避免可能导致严重问题的错误和其他问题。

 

Tags