Pull Requests

Warum diese Funktion verwenden?

• Zeit sparen: Generieren Sie automatisch detaillierte PR-Beschreibungen basierend auf Ihren Änderungen.
• Konsistenz wahren: Stellen Sie sicher, dass alle PRs einem konsistenten Format folgen.
• Zusammenarbeit verbessern: Bieten Sie Reviewern klaren Kontext mit gut strukturierten Beschreibungen.
• Workflow optimieren: Erstellen Sie PRs, ohne Ihre IDE zu verlassen.

Wie es funktioniert

Bob analysiert Ihre Branch-Änderungen, Commit-Historie und Branch-Namen, um den Zweck und Umfang Ihrer Arbeit zu verstehen. Es generiert dann einen aussagekräftigen PR-Titel und eine detaillierte Beschreibung, die Ihre Änderungen zusammenfasst und es Reviewern erleichtert, den Kontext und Zweck Ihres PRs zu verstehen. Nach der Generierung können Sie die PR-Beschreibung vor der Einreichung überprüfen und bearbeiten.

Der PR-Generierungsprozess ist interaktiv und ermöglicht es Ihnen, den Ziel-Branch und das Remote-Repository vor der Erstellung des PRs auszuwählen.

Erste Schritte

Voraussetzungen

• Ihre Änderungen müssen in einen Branch committet sein.
• Sie müssen Push-Zugriff auf das Remote-Repository haben.

Grundlegende Verwendung

Sie können aus 3 Optionen wählen, um einen PR-Flow zu initiieren:

• Klicken Sie auf das PR-Symbol im Source Control-Panel.
• Verwenden Sie die Befehlspalette (Cmd + Shift + P auf Mac, Ctrl + Shift + P auf Windows/Linux) und suchen Sie nach "Bob: Generate PR".
• Geben Sie /create-pr in der Bob-Chat-Oberfläche ein.

Bob führt Sie dann durch die folgenden Schritte:

1. Wählen Sie den Basis-Branch aus, in den Sie mergen möchten. Bob schlägt die drei wahrscheinlichsten Branches vor.
2. Wählen Sie das Remote-Repository aus, wenn Sie mehrere Remotes haben.
3. Überprüfen Sie die generierte PR-Beschreibung und den Titel.
4. Erstellen Sie den PR.
5. Erhalten Sie den Link zum neu erstellten PR in Ihrem Chat.

Vorlagen für PR-Beschreibungen verwenden

Bob erkennt und verwendet automatisch die vorhandenen PR-Vorlagen Ihres Projekts beim Generieren von Pull-Request-Beschreibungen. Dies stellt sicher, dass Ihre PRs mit den etablierten Standards Ihres Teams konsistent sind. Wenn Bob mehrere PR-Vorlagen in Ihrem Projekt erkennt, können Sie auswählen, welche Vorlage auf Ihren Pull Request angewendet werden soll.

Vorlagenerkennung

Bob sucht nach PR-Vorlagen an den folgenden Speicherorten relativ zu Ihrem Projektstamm:

1. ${cwd}/pull_request_template.md
2. ${cwd}/docs/pull_request_template.md
3. ${cwd}/.github/pull_request_template.md
4. ${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
5. ${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
6. ${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

Wenn Bob mehrere Vorlagen findet, wird Bob den Benutzer bitten, auszuwählen, welche Vorlage für die PR-Beschreibung verwendet werden soll.

Standardvorlage

Wenn keine Vorlage in Ihrem Projekt gefunden wird, verwendet Bob eine integrierte Vorlage, die Folgendes enthält:

• Einen beschreibenden Titel, der von Ihrem Branch-Namen abgeleitet ist
• Eine Zusammenfassung der Änderungen
• Wichtige Implementierungsdetails
• Testinformationen
• Alle relevanten Links oder Referenzen

Die generierte Beschreibung bearbeiten

Nach dem Generieren der PR-Beschreibung zeigt Bob sie direkt im Chat an. Du kannst dann:

• Bestätigen und fortfahren: Genehmige die Beschreibung so, wie sie ist, um mit der Erstellung des PR fortzufahren.
• Änderungen anfordern: Gib dein Feedback im Chat ein und Bob generiert die Beschreibung basierend auf deinen Eingaben neu. Du kannst so oft iterieren, wie du möchtest, bevor du bestätigst.

Vorlagen anpassen

Für die besten Ergebnisse mit Bobs PR-Generierung:

• Verwenden Sie klare Abschnittsüberschriften in Ihren Vorlagen (z.B. ## Zusammenfassung, ## Änderungen)
• Fügen Sie Platzhaltertext hinzu, der Kontext bietet (z.B. <!-- Beschreiben Sie den Zweck dieses PRs -->)
• Erwägen Sie das Hinzufügen von Abschnitten für Testanweisungen und verwandte Probleme

Tipps und Best Practices

• Verwenden Sie beschreibende Branch-Namen, um Bob zu helfen, genauere PR-Beschreibungen zu generieren.
• Überprüfen und bearbeiten Sie die generierte Beschreibung, bevor Sie den PR erstellen.