Création de règles de projet à utiliser avec Amazon Q Developer Chat - Amazon Q Developer

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création de règles de projet à utiliser avec Amazon Q Developer Chat

Vous pouvez créer une bibliothèque de règles de projet que vous pouvez utiliser lorsque vous discutez avec Amazon Q dans l'IDE. Ces règles décrivent les normes de codage et les bonnes pratiques en vigueur au sein de votre équipe. Par exemple, vous pouvez définir une règle stipulant que tout le code Python doit utiliser des annotations de type (type hints), ou que tout le code Java doit utiliser des commentaires Javadoc. En stockant ces règles dans votre projet, vous garantissez une cohérence parmi les développeurs, quel que soit leur niveau d’expérience.

Les règles du projet sont définies dans les fichiers Markdown du dossier project-root/.amazonq/rules du projet.

Une fois que vous avez créé les règles de votre projet, Amazon Q les utilisera automatiquement comme contexte chaque fois qu'un développeur discute avec Amazon Q dans le cadre de votre projet, et veillera à les respecter lors de la génération des réponses. Pour plus d'informations sur l'ajout de contexte au chat, consultezAjouter du contexte au chat Amazon Q Developer dans l'IDE.

Vous pouvez créer des règles de projet directement dans le système de fichiers ou via l'interface de chat Amazon Q.

Pour créer une règle de projet à l'aide de l'interface de chat Amazon Q

  1. Dans votre IDE, ouvrez le panneau de discussion Amazon Q.

  2. Dans la zone de saisie du chat, cliquez sur le bouton Règles.

  3. Sélectionnez Créer une nouvelle règle.

  4. Dans la boîte de dialogue qui apparaît, saisissez le nom de votre règle.

    Cela créera un fichier Markdown portant ce nom dans le project-root/.amazonq/rules dossier de votre projet.

  5. Ajoutez le contenu de votre règle dans l'éditeur.

  6. Enregistrez le fichier.

Pour créer une règle de projet à l’aide du système de fichiers

  1. Dans votre IDE, ouvrez le dossier racine du projet.

  2. Dans le dossier racine du projet, créez le dossier suivant :

    project-root/.amazonq/rules

    Ce dossier contient toutes les règles de votre projet.

  3. Dans project-root/.amazonq/rules, créez un fichier de règles du projet. Il doit s’agir d’un fichier Markdown. Par exemple :

    cdk-rules.md

  4. Ouvrez le fichier de règles Markdown de votre projet.

  5. Ajoutez une invite détaillée au fichier. Par exemple :

    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. Enregistrez le fichier.

  7. (Facultatif) Ajoutez d’autres fichiers de règles Markdown à votre projet.

    Vous avez maintenant une ou plusieurs règles de projet. Amazon Q utilisera automatiquement ces règles comme contexte chaque fois qu'un développeur discute avec Amazon Q dans le cadre de votre projet.

Pour gérer les règles dans l'interface de chat Amazon Q

  1. Dans votre IDE, ouvrez le panneau de discussion Amazon Q.

  2. Dans la zone de saisie du chat, cliquez sur le bouton Règles pour voir toutes les règles disponibles.

  3. Cliquez sur une règle pour l'activer ou la désactiver pour la session de chat en cours :

    • Les règles cochées sont actives et seront appliquées à votre conversation.

    • Les règles non cochées sont inactives pour la session en cours.