Erstellen von Projektregeln für die Verwendung mit dem Chat von Amazon Q Developer - Amazon Q Developer

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.

Erstellen von Projektregeln für die Verwendung mit dem Chat von Amazon Q Developer

Sie können eine Bibliothek mit Projektregeln erstellen, die Sie beim Chatten mit Amazon Q in der IDE verwenden können. Diese Regeln beschreiben Codierungsstandards und bewährte Methoden in Ihrem Team. Sie könnten beispielsweise eine Regel vorliegen haben, die besagt, dass der gesamte Python-Code Typhinweise oder der gesamte Java-Code Javadoc-Kommentare verwenden muss. Indem Sie diese Regeln in Ihrem Projekt speichern, können Sie sicherstellen, dass alle Entwickler unabhängig von ihrer Erfahrung Konsistenz waren.

Projektregeln werden in Markdown-Dateien im Projektordner project-root/.amazonq/rules definiert.

Sobald Sie Ihre Projektregeln erstellt haben, verwendet Amazon Q sie automatisch als Kontext, sobald ein Entwickler innerhalb Ihres Projekts mit Amazon Q chattet, und stellt sicher, dass sie bei der Generierung von Antworten eingehalten werden. Weitere Informationen über das Hinzufügen von Kontext zum Chat finden Sie unter Hinzufügen von Kontext zum Chat von Amazon Q Developer in der IDE.

Sie können Projektregeln entweder direkt im Dateisystem oder über die Chat-Oberfläche von Amazon Q erstellen.

So erstellen Sie eine Projektregel mithilfe der Chat-Oberfläche von Amazon Q

  1. Öffnen Sie in Ihrer IDE das Chat-Panel von Amazon Q.

  2. Klicken Sie im Chat-Eingabefeld auf die Schaltfläche Regeln.

  3. Wählen Sie Neue Regel erstellen aus.

  4. Geben Sie im angezeigten Dialogfeld einen Namen für die Regel ein.

    Dadurch wird eine Markdown-Datei mit diesem Namen im Ordner project-root/.amazonq/rules des Projekts erstellt.

  5. Fügen Sie den Regelinhalt im Editor hinzu.

  6. Speichern Sie die Datei.

So erstellen Sie eine Projektregel mithilfe des Dateisystems

  1. Öffnen Sie in Ihrer IDE den Stammordner des Projekts.

  2. Legen Sie im Stammordner des Projekts den folgenden Ordner an:

    project-root/.amazonq/rules

    Dieser Ordner enthält alle Ihre Projektregeln.

  3. Erstellen Sie in project-root/.amazonq/rules eine Projektregeldatei. Es muss sich um eine Markdown-Datei handeln. Zum Beispiel:

    cdk-rules.md

  4. Öffnen Sie die Markdown-Datei für Projektregeln.

  5. Fügen Sie der Datei einen detaillierten Prompt hinzu. Zum Beispiel:

    All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled. 
All Amazon SNS topics must have encryption enabled and enforce SSL. 
All Amazon SNS queues must enforce SSL.

  6. Speichern Sie die Datei.

  7. (Optional) Fügen Sie weitere Markdown-Dateien für Projektregeln hinzu.

    Sie haben nun eine oder mehrere Projektregeln erstellt. Amazon Q verwendet diese Regeln automatisch als Kontext, sobald ein Entwickler innerhalb Ihres Projekts mit Amazon Q chattet.

So verwalten Sie Regeln auf der Chat-Oberfläche von Amazon Q

  1. Öffnen Sie in Ihrer IDE das Chat-Panel von Amazon Q.

  2. Klicken Sie im Chat-Eingabefeld auf die Schaltfläche Regeln, um alle verfügbaren Regeln zu sehen.

  3. Klicken Sie auf eine Regel, um sie für die aktuelle Chat-Sitzung ein- oder auszuschalten:

    • Regeln mit einem Häkchen sind aktiv und werden auf Ihre Konversation angewendet.

    • Regeln ohne Häkchen sind für die aktuelle Sitzung inaktiv.