为什么我的拉取请求描述会不断被修改？了解修改描述的原因以及审阅者的建议

《ACM Transactions on Software Engineering and Methodology》：Why Are My Pull Request Descriptions Constantly Revised? Understanding Modifying Descriptions and Reviewer Suggestions

代码审查效率研究揭示PR描述修改采纳率仅60%，但采纳建议的PR被接受概率提升4.31倍，通过分析70,314条修改建议提炼出五类17项信息要素，并基于在线调查提出八项高质量描述实践标准。

　　

摘要人工智能摘要

要查看此由人工智能生成的摘要，您必须具有高级访问权限。

了解更多登录

摘要

摘要

在GitHub上，开发者通过拉取请求（PR）将代码更改提交到项目中，这些请求包含描述，以帮助审阅者理解修改内容并做出明智的审阅决策。然而，开发者提供的PR描述有时可能不够清晰。我们发现四分之一的PR描述经过了修改。这个过程对开发者和审阅者来说都可能非常耗时。以往的研究主要集中在PR描述的自动生成上，而忽视了理解审阅者提出的修改建议的重要性。理解这些建议对于改进PR描述至关重要，可以确保沟通清晰有效，并加快审阅流程。为了解决这个问题，我们对70,314个描述经过修改的PR进行了实证研究。我们识别出五种类别和17种类型的信息元素，例如“功能概述”、“动机”和“相关问题”。令人惊讶的是，40%的建议没有被采纳。我们分析了开发者选择不采纳这些建议的原因，包括建议不正确或难以实施等。通过回归实验，我们发现按照建议修改描述与PR被接受的几率相比提高了4.31倍。为了更好地理解什么是高质量的PR描述，我们进行了一项在线调查，以探索编写PR描述的最佳实践。这些实践强调了清晰度、背景和技术细节的重要性，其中八项被认定为高度重要。基于这些发现，我们为开发者和工具设计者提出了建议。

人工智能摘要

人工智能生成的摘要（实验性)

此摘要是使用自动化工具生成的，并非由文章作者编写或审阅。它旨在帮助发现、帮助读者评估相关性，并协助来自相关研究领域的读者理解本文内容。它旨在补充作者提供的摘要，后者仍是论文的主要摘要。完整文章仍然是权威版本。点击此处了解更多。

点击此处对摘要的准确性、清晰度和实用性进行评论。您的反馈将有助于改进未来的摘要版本。

要查看此由人工智能生成的通俗语言摘要，您必须具有高级访问权限。