Création de règles de projet pour Amazon Q Developer sur des plateformes tierces - 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 pour Amazon Q Developer sur des plateformes tierces

Vous pouvez créer une bibliothèque de règles de projet que vous pouvez utiliser avec Amazon Q Developer dans GitLab ou GitHub. Ces règles décrivent les normes de codage et les meilleures pratiques au sein de votre équipe. Par exemple, vous pouvez avoir une règle stipulant que tout le code Python doit utiliser des indications de type ou que tout le code Java doit utiliser des commentaires Javadoc. En stockant ces règles dans votre projet, vous pouvez garantir la cohérence entre les développeurs, quel que soit leur niveau d'expérience.

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

Une fois que vous avez créé les règles de votre projet, Amazon Q Developer les utilisera automatiquement comme contexte au sein de votre projet et veillera à les respecter lors de la génération de code pour le développement de fonctionnalités.

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

  1. Dans votre référentiel tiers, ouvrez le dossier racine de votre 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. Dansproject-root/.amazonq/rules, créez un fichier de règles de projet. Il doit s'agir d'un fichier Markdown. Par exemple :

    cdk-rules.md

  4. Ouvrez le fichier Markdown des règles 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. Validez, révisez et fusionnez vos modifications.

  7. (Facultatif) Ajoutez d'autres fichiers Markdown de règles de projet.

    Vous venez de créer une ou plusieurs règles de projet. Amazon Q utilisera automatiquement ces règles comme contexte dans votre projet.