Erstellen von Projektregeln für Amazon Q Developer auf Plattformen von Drittanbietern - 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 Amazon Q Developer auf Plattformen von Drittanbietern

Sie können eine Bibliothek mit Projektregeln erstellen, die Sie mit Amazon Q Developer in GitLab oder GitHub 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 Developer sie automatisch als Kontext in Ihrem Projekt und stellt sicher, dass sie bei der Generierung von Code für die Funktionsentwicklung eingehalten werden.

So erstellen Sie eine Projektregel mithilfe des Dateisystems

  1. Öffnen Sie in Ihrem Drittanbieter-Repository den Stammordner Ihres 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. Bestätigen Sie Ihre Änderungen durch Commit, überprüfen Sie sie und führen Sie sie zusammen.

  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 in Ihrem Projekt.