Création de règles de projet pour Amazon Q Developer sur des plateformes tierces - Amazon Q Developer

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 susceptible d’être utilisée avec Amazon Q Developer dans GitLab ou GitHub. 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 Developer les utilise automatiquement comme contexte au sein de votre projet et veille à les respecter lors de la génération de code pour le développement des 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. 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. Valider, réviser et fusionner vos modifications.

  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 dans votre projet.