Projektregeln für die Verwendung mit dem Amazon Q Developer Chat erstellen - 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.

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

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 haben, die besagt, dass der gesamte Python-Code Typhinweise verwenden muss oder dass 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 ihrem Erfahrungsstand einheitlich sind.

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

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

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

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

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

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

  3. Wählen Sie Neue Regel erstellen aus.

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

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

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

  6. Speichern Sie die Datei.

Um eine Projektregel mithilfe des Dateisystems zu erstellen

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

  2. Erstellen Sie im Stammordner des Projekts den folgenden Ordner:

    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 Ihre Markdown-Datei für Projektregeln.

  5. Fügen Sie der Datei eine detaillierte Aufforderung 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 jetzt eine oder mehrere Projektregeln erstellt. Amazon Q verwendet diese Regeln automatisch als Kontext, wenn ein Entwickler innerhalb Ihres Projekts mit Amazon Q chattet.

Um Regeln in der Amazon Q-Chat-Oberfläche zu verwalten

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

  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.