Einblicke in die Verwendung von Codeausschnitten in Codereview-Prozessen: Eine Studie der OpenStack- und Qt-Gemeinschaften und eine Umfrage unter Praktikern

Core Concepts

Codeausschnitte werden nicht häufig in Codereview-Prozessen verwendet, und die meisten Codeausschnitte werden von Reviewern anstatt von Entwicklern bereitgestellt. Die Hauptzwecke der Reviewer, Codeausschnitte in Codereview-Prozessen bereitzustellen, sind Vorschlag und Zitat, wobei Vorschlag der Hauptzweck ist. Die meisten Entwickler würden die Codeausschnittvorschläge der Reviewer akzeptieren, und die häufigsten Gründe, warum Entwickler die Codeausschnittvorschläge der Reviewer nicht akzeptieren, sind Meinungsunterschiede zwischen Entwicklern und Reviewern sowie fehlerhafte Vorschläge der Reviewer.

Abstract

Die Studie umfasste zwei Phasen: In Phase 1 führten wir eine explorative Studie durch, um Codereview-Daten aus den beiden beliebten Entwicklergemeinschaften OpenStack und Qt zu analysieren. Wir haben 69.604 Reviewkommentare manuell gekennzeichnet und schließlich 3.213 Reviewkommentare identifiziert, die Codeausschnitte enthalten. Basierend auf den gesammelten Codereview-Daten analysierten wir den Umfang der Verwendung von Codeausschnitten, die Zwecke der Reviewer beim Bereitstellen von Codeausschnitten, die Akzeptanz der Entwickler für Codeausschnittvorschläge und die Gründe, warum Entwickler Codeausschnittvorschläge der Reviewer nicht akzeptieren. In Phase 2 verwendeten wir einen Online-Fragebogen, um Praktiker aus der Industrie zu befragen. Durch die Analyse der 63 gültigen Antworten, die wir erhalten haben, erkundeten wir die Szenarien, in denen Reviewer Codeausschnitte bereitstellen, die Einstellungen der Entwickler gegenüber Codeausschnitten und die Merkmale von Codeausschnitten, die Entwickler von Reviewern in Codereview-Prozessen erwarten. Die Ergebnisse zeigen, dass: Codeausschnitte werden in Codereview-Prozessen nicht häufig verwendet, und die meisten Codeausschnitte werden von Reviewern anstatt von Entwicklern bereitgestellt. Die Hauptzwecke der Reviewer, Codeausschnitte in Codereview-Prozessen bereitzustellen, sind Vorschlag und Zitat, wobei Vorschlag der Hauptzweck ist. Die meisten Entwickler würden die Codeausschnittvorschläge der Reviewer akzeptieren. Die häufigsten Gründe, warum Entwickler die Codeausschnittvorschläge der Reviewer nicht akzeptieren, sind Meinungsunterschiede zwischen Entwicklern und Reviewern sowie fehlerhafte Vorschläge der Reviewer. Reviewer stellen oft Codeausschnitte in Codereview-Prozessen bereit, wenn der Code anschaulicher als Worte ist. Die meisten Entwickler haben eine positive Einstellung gegenüber Codeausschnittkommentaren. Die meisten Entwickler erwarten, dass Codeausschnitte in Reviewkommentaren verständlich und in den bestehenden Code passend sind.

Stats

"Codeausschnitte werden in Codereview-Prozessen nicht häufig verwendet." "Die meisten Codeausschnitte werden von Reviewern anstatt von Entwicklern bereitgestellt." "Die Hauptzwecke der Reviewer, Codeausschnitte in Codereview-Prozessen bereitzustellen, sind Vorschlag und Zitat, wobei Vorschlag der Hauptzweck ist." "Die meisten Entwickler würden die Codeausschnittvorschläge der Reviewer akzeptieren." "Die häufigsten Gründe, warum Entwickler die Codeausschnittvorschläge der Reviewer nicht akzeptieren, sind Meinungsunterschiede zwischen Entwicklern und Reviewern sowie fehlerhafte Vorschläge der Reviewer." "Reviewer stellen oft Codeausschnitte in Codereview-Prozessen bereit, wenn der Code anschaulicher als Worte ist." "Die meisten Entwickler haben eine positive Einstellung gegenüber Codeausschnittkommentaren." "Die meisten Entwickler erwarten, dass Codeausschnitte in Reviewkommentaren verständlich und in den bestehenden Code passend sind."

Quotes

"Kürzerer Vorschlag: return parent.isValid() ? treeItemAtIndex(parent)->childCount() : m_rootItem->childCount();" "Wenn wir so optimieren wollen wie möglich, könnten wir uns auf nur die neutron pg drop Zeile mit etwas wie beschränken: [Codeausschnitt]" "... libvirt wird etwas Ähnliches tun, aber bis wir das tatsächlich aus irgendeinem Grund brauchen, würde ich es vorziehen, die zusätzliche Komplexität nicht hinzuzufügen."

Key Insights Distilled From

Demystifying Code Snippets in Code Reviews

by Beiqi Zhang,... at arxiv.org 04-05-2024

https://arxiv.org/pdf/2307.14406.pdf

Deeper Inquiries

Wie können Reviewer Codeausschnitte effektiv nutzen, um den Codereview-Prozess zu verbessern und die Zusammenarbeit zwischen Entwicklern und Reviewern zu fördern?

Um Codeausschnitte effektiv zu nutzen, können Reviewer sie verwenden, um konkrete Verbesserungsvorschläge zu machen, Codekonventionen zu verdeutlichen, Fehler im Code aufzuzeigen, den Code zu ergänzen, Erklärungen zu unterstützen und zusätzliche Kontextinformationen bereitzustellen. Durch die Verwendung von Codeausschnitten können Reviewer ihre Kommentare präziser und verständlicher gestalten, was die Effizienz des Codereview-Prozesses verbessert und die Kommunikation zwischen Entwicklern und Reviewern fördert.

Welche Herausforderungen und Risiken können auftreten, wenn Entwickler Codeausschnitte in Codereview-Prozessen ablehnen, und wie können diese Herausforderungen angegangen werden?

Einige Herausforderungen und Risiken, die auftreten können, wenn Entwickler Codeausschnitte in Codereview-Prozessen ablehnen, sind unterschiedliche Meinungen zwischen Entwicklern und Reviewern, unzureichende Erklärungen in den Codeausschnitten, mangelnde Akzeptanz neuer Ideen und Widerstand gegen Veränderungen. Diese Herausforderungen können durch eine verbesserte Kommunikation, klare Erklärungen in den Codeausschnitten, offene Diskussionen über die vorgeschlagenen Änderungen und Schulungen zur Sensibilisierung für die Vorteile von Codeausschnitten angegangen werden.

Wie könnte die Verwendung von Codeausschnitten in Codereview-Prozessen mit anderen Technologien wie künstlicher Intelligenz oder maschinellem Lernen integriert werden, um den Codereview-Prozess weiter zu verbessern?

Die Integration von Codeausschnitten in Codereview-Prozessen mit künstlicher Intelligenz oder maschinellem Lernen könnte dazu beitragen, automatisierte Codeanalysen durchzuführen, um potenzielle Fehler oder Verbesserungsvorschläge zu identifizieren. Durch die Verwendung von Algorithmen zur Codeanalyse könnten Codeausschnitte effizienter bewertet und Empfehlungen für Codeänderungen generiert werden. Darüber hinaus könnten maschinelle Lernalgorithmen verwendet werden, um Muster in Codeausschnitten zu erkennen und Entwicklern und Reviewern personalisierte Vorschläge für Codeverbesserungen zu bieten.