Überprüfen von Code mit Amazon Q Developer in GitHub - Amazon Q Developer
VoraussetzungenInitiieren von Codeüberprüfungen für GitHub-Pull-AnforderungenInitiieren von Codeüberprüfungen in GitHub-Pull-Anforderungen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Überprüfen von Code mit Amazon Q Developer in GitHub

Anmerkung

Bei Amazon Q Developer für GitHub handelt es sich um eine Vorversion, die Änderungen unterliegt.

Amazon Q Developer ermöglicht automatisierte Codeüberprüfungen innerhalb von GitHub. Wenn eine neue Pull-Anforderung erstellt oder eine abgeschlossene Pull-Anforderung erneut geöffnet wird, führt Amazon Q Developer automatisch eine Codeüberprüfung durch und gibt Feedback zur Codequalität, zu potenziellen Problemen und schwerwiegenden Sicherheitsbedenken. Jede Überprüfung enthält eine Zusammenfassung der Codeüberprüfung mit zusammengefassten Ergebnissen. Amazon Q Developer generiert auch Korrekturen für die identifizierten Probleme, die Sie überprüfen und per Commit an die Pull-Anforderung übergeben können. Sie können den /q-Befehl in den Kommentaren zu Pull-Anforderungen verwenden, um Fragen zu stellen und im Hinblick auf die Ergebnisse der Codeüberprüfung zu interagieren. Automatische Codeüberprüfungen werden nicht durch nachfolgende Commits ausgelöst, die innerhalb einer bestehenden Pull-Anforderung vorgenommen wurden.

Sie können mit dem /q review-Slash-Befehl Codeüberprüfungen auch innerhalb von Pull-Anforderungen initiieren. Der Slash-Befehl kann zu einem neuen Pull-Anforderungskommentar hinzugefügt werden, wodurch eine neue Codeüberprüfung der Pull-Anforderungen in seinem aktuellen Status initiiert wird, einschließlich aller Kommentare und neuer Commits. Weitere Informationen finden Sie unter Initiieren von Codeüberprüfungen in GitHub-Pull-Anforderungen.

Sie können Amazon Q Developer eine Codeüberprüfung für eine begrenzte Anzahl von Zeilen pro Monat durchführen lassen. Sie können Ihre kostenlose Nutzung jederzeit erhöhen, indem Sie Ihre Amazon Q Developer-App-Installation mit Ihrem AWS Konto registrieren. Weitere Informationen finden Sie unter Erhöhen der Nutzungsbeschränkungen und Konfigurieren der Details in der Konsole von Amazon Q Developer.

Anmerkung

Wenn die Funktion zur Codeüberprüfung zuvor deaktiviert war, muss sie in der Konsole von Amazon Q Developer aktiviert werden, bevor Sie das Label in GitHub anwenden können. Weitere Informationen finden Sie unter Bearbeiten von Funktionen für Amazon Q Developer in GitHub.

Voraussetzungen

Bevor Sie Codeüberprüfungen mit Amazon Q Developer initiieren können, benötigen Sie die entsprechenden Berechtigungen für das GitHub-Ziel-Repository. Die unterstützten Repository-Rollen sind Write, Maintain oder Admin. Benutzer mit den Rollen Read oder Triage sowie Mitglieder ohne Rolle können keine Codeüberprüfungen in Amazon Q Developer initiieren.

GitHub-Benutzer mit der Triage-Rolle können weiterhin Pull-Anforderungen in einem Repository überprüfen. Jeder Benutzer kann unabhängig von seiner Rolle Pull-Anforderungen in öffentlichen Repositorys überprüfen.

Weitere Informationen erhalten Sie unter Repositoryrollen für Organisationen und Über vordefinierte Organisationsrollen in der GitHub-Dokumentation.

Initiieren von Codeüberprüfungen für GitHub-Pull-Anforderungen

Wenn Sie eine neue Pull-Anforderung öffnen oder eine zuvor geschlossene erneut öffnen, führt Amazon Q Developer automatisch eine Codeüberprüfung durch und gibt Feedback zur Codequalität, zu möglichen Problemen und wichtigen Ergebnissen.

So verwenden Sie Amazon Q Developer für Codeüberprüfungen und das Anwenden von Korrekturen

Bevor Sie mit einer Überprüfung beginnen, können Sie eine Überprüfung der Codequalität anpassen, indem Sie benutzerdefinierte Programmierstandards in einfachen Markdown-Dateien im Verzeichnis project-root/.amazonq/rules definieren. Amazon Q folgt automatisch Ihren Richtlinien und gewährleistet so eine gleichbleibende Codequalität während Ihres gesamten Projekts. Weitere Informationen finden Sie unter Erstellen von Projektregeln für Amazon Q Developer auf Plattformen von Drittanbietern.

  1. Melden Sie sich beim GitHub-Konto mit Ihren GitHub-Anmeldeinformationen an.

  2. Navigieren Sie zu Ihrer GitHub-Organisation und dann zu dem Repository, in dem Sie eine Codeüberprüfung mit Amazon Q Developer durchführen möchten.

  3. Erstellen Sie eine neue Pull-Anforderung für Änderungen, die an Ihrem Quellcode vorgenommen wurden. Weitere Informationen erhalten Sie unter Erstellen eines Pull Requests in der GitHub-Dokumentation.

    Wenn Sie eine neue Pull-Anforderung erstellen, beginnt Amazon Q Developer automatisch mit einer Codeüberprüfung, um potenzielle Probleme zu finden. Sobald Amazon Q Developer die Überprüfung abgeschlossen hat, wird eine Zusammenfassung der Codeüberprüfung angezeigt. Jedes Ergebnis wird als Thread-Kommentar unter der Zusammenfassung angezeigt, zusammen mit Lösungsvorschlägen, die Sie in die Pull-Anforderung übernehmen können.

  4. Bitten Sie den Agenten, Änderungen zu implementieren und Commits direkt im Quell-Branch Ihrer Pull-Anfrage zu erstellen. Du kannst dies tun, indem du einen Kommentar postest, der mit deiner Anfrage in natürlicher Sprache beginnt /q und darauf folgt, damit der Agent Änderungen vornehmen kann.

  5. (Optional) Stellen Sie Fragen zu bestimmten Ergebnissen. Navigieren Sie innerhalb der Pull-Anforderung zu Kommentar hinzufügen und geben Sie in das Texteingabefeld für den Kommentar /q gefolgt von Ihrer Frage (z. B. "/q explain the importance of this finding„) ein.

  6. Überprüfen Sie die von Amazon Q Developer vorgeschlagenen Codeänderungen, wählen Sie Commit suggestion und dann Änderungen committen aus, um die Pull-Anforderung zu aktualisieren.

  7. Wenn Sie mit den vorgeschlagenen Codekorrekturen zufrieden sind, können Sie die Pull-Anforderung zusammenführen, um die von Amazon Q Developer vorgeschlagenen Änderungen zu übernehmen. Weitere Informationen erhalten Sie unter Einen Pull Request zusammenführen in der GitHub-Dokumentation.

Initiieren von Codeüberprüfungen in GitHub-Pull-Anforderungen

Nach einer automatischen Codeüberprüfung, die von Amazon Q Developer für eine neue oder erneut geöffnete GitHub-Pull-Anforderung durchgeführt wurde, können Sie mit dem /q review-Slash-Befehl zusätzliche Codeüberprüfungen einleiten, um Ihren Code zu iterieren. Die Codeüberprüfung wird für den gesamten Vergleich der Pull-Anforderung durchgeführt.

Anmerkung

Sie können eine Codeüberprüfung nur innerhalb einer Pull-Anforderung mit einem neuen Kommentar einleiten. Der /q review-Slash-Befehl funktioniert nicht in einem vorhandenen Kommentar-Thread.

So leiten Sie Codeüberprüfungen in einer Pull-Anforderung ein

  1. Melden Sie sich beim GitHub-Konto mit Ihren GitHub-Anmeldeinformationen an.

  2. Navigieren Sie zu Ihrer GitHub-Organisation und dann zu der Pull-Anforderung, in der Sie eine Codeüberprüfung mit Amazon Q Developer durchführen möchten. Weitere Informationen erhalten Sie unter Informationen zu Pull-Anforderungen.

  3. Navigieren Sie innerhalb der Pull-Anforderung zu Einen Kommentar hinzufügen und geben Sie in das Texteingabefeld für den Kommentar den Text /q review ein.

  4. Wählen Sie Kommentar aus, um die Codeüberprüfung zu starten.

    Es kann einige Minuten dauern, bis Amazon Q Developer die Analyse des Pull-Anforderungscodes abgeschlossen hat. Nachdem Amazon Q Developer die Analyse abgeschlossen hat, wird eine Zusammenfassung der Codeüberprüfung angezeigt. Jedes Ergebnis wird als Thread-Kommentar unter der Zusammenfassung angezeigt, zusammen mit Lösungsvorschlägen, die Sie in die Pull-Anforderung übernehmen können, um diese zu aktualisieren.

  5. (Optional) Stellen Sie Fragen zu bestimmten Ergebnissen. Navigieren Sie innerhalb der Pull-Anforderung zu Kommentar hinzufügen und geben Sie in das Texteingabefeld für den Kommentar /q gefolgt von Ihrer Frage (z. B. "/q explain the importance of this finding„) ein.

  6. Wenn Sie mit den vorgeschlagenen Codekorrekturen zufrieden sind, können Sie die Pull-Anforderung zusammenführen, um die von Amazon Q Developer vorgeschlagenen Änderungen zu übernehmen. Weitere Informationen erhalten Sie unter Einen Pull Request zusammenführen in der GitHub-Dokumentation.