Tutoriel : Utiliser les fonctionnalités CodeCatalyst génératives de l'IA pour accélérer votre travail de développement - Amazon CodeCatalyst
PrérequisUtiliser Amazon Q pour choisir un plan lors de la création d'un projet ou de l'ajout de fonctionnalitésAjouter un résumé généré automatiquement lors de la création d'une pull requestCréez un résumé des commentaires laissés sur les modifications de code dans une pull requestCréez un problème et attribuez-le à Amazon QCréez un problème et demandez à Amazon Q de vous recommander des tâches à ce sujetNettoyage des ressources

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.

Tutoriel : Utiliser les fonctionnalités CodeCatalyst génératives de l'IA pour accélérer votre travail de développement

Si vous avez un projet et un référentiel de sources sur Amazon CodeCatalyst dans un espace où les fonctionnalités d'IA générative sont activées, vous pouvez utiliser ces fonctionnalités pour accélérer le développement de logiciels. Les développeurs ont souvent plus de tâches à accomplir que de temps pour les accomplir. Ils ne prennent souvent pas le temps d'expliquer leurs modifications de code à leurs collègues lorsqu'ils créent des pull requests pour examiner ces modifications, s'attendant à ce que les autres utilisateurs trouvent ces modifications explicites. Les créateurs et réviseurs de pull request n'ont pas non plus le temps de rechercher et de lire attentivement tous les commentaires sur une pull request, en particulier si la pull request comporte plusieurs révisions. CodeCatalyst s'intègre à l'agent de développement Amazon Q pour le développement de logiciels afin de fournir des fonctionnalités d'IA génératives qui peuvent à la fois aider les membres de l'équipe à accomplir leurs tâches plus rapidement et augmenter le temps dont ils disposent pour se concentrer sur les aspects les plus importants de leur travail.

Amazon Q Developer est un assistant conversationnel génératif alimenté par l'IA qui peut vous aider à comprendre, créer, étendre et exploiter des applications. AWS Pour accélérer votre développement AWS, le modèle sur lequel repose Amazon Q est complété par AWS du contenu de haute qualité afin de produire des réponses plus complètes, exploitables et référencées. Pour plus d'informations, consultez Qu'est-ce qu'Amazon Q Developer ? dans le guide de l'utilisateur Amazon Q Developer.

Note

Propulsé par Amazon Bedrock : AWS implémente la détection automatique des abus. Dans la mesure où les fonctionnalités Écrire une description pour moi, Créer un résumé du contenu, recommander des tâches, utiliser Amazon Q pour créer ou ajouter des fonctionnalités à un projet et Attribuer des problèmes à Amazon Q avec Amazon Q Developer Agent pour les fonctionnalités de développement logiciel sont basées sur Amazon Bedrock, les utilisateurs peuvent tirer pleinement parti des contrôles mis en œuvre dans Amazon Bedrock pour renforcer la sûreté, la sécurité et l'utilisation responsable de l'intelligence artificielle (IA).

Dans ce didacticiel, vous apprendrez à utiliser les fonctionnalités de l'IA générative pour vous aider CodeCatalyst à créer des projets avec des plans, ainsi qu'à ajouter des plans à des projets existants. En outre, vous apprendrez à résumer les modifications entre les branches lors de la création de pull requests et à synthétiser les commentaires laissés sur une pull request. Vous apprendrez également à créer des problèmes avec vos idées de modification ou d'amélioration du code et à les attribuer à Amazon Q. Dans le cadre de la résolution des problèmes assignés à Amazon Q, vous apprendrez comment autoriser Amazon Q à suggérer des tâches et comment attribuer et travailler sur les tâches créées dans le cadre de la résolution d'un problème.

Prérequis

Pour utiliser les CodeCatalyst fonctionnalités de ce didacticiel, vous devez d'abord avoir terminé les ressources suivantes et y avoir accès :

  • Vous disposez d'un AWS Builder ID ou d'une identité d'authentification unique (SSO) à laquelle vous pouvez vous connecter CodeCatalyst.

  • Vous vous trouvez dans un espace où les fonctionnalités d'IA génératives sont activées. Pour plus d'informations, consultez la section Gestion des fonctionnalités d'IA générative.

  • Vous avez le rôle de contributeur ou d'administrateur de projet dans un projet dans cet espace.

  • À moins que vous ne créiez un projet avec une IA générative, votre projet existant possède au moins un référentiel source configuré pour celui-ci. Les référentiels liés ne sont pas pris en charge.

  • Lorsque vous attribuez des problèmes à une solution initiale créée par l'IA générative, le projet ne peut pas être configuré avec l'extension Jira Software. L'extension n'est pas prise en charge pour cette fonctionnalité.

Pour plus d'informations, consultez Création d'un espace, Suivez et organisez le travail en cas de problèmes dans CodeCatalyst, Ajoutez des fonctionnalités aux projets avec des extensions dans CodeCatalyst et Octroi d'accès avec des rôles d'utilisateur.

Ce didacticiel est basé sur un projet créé à l'aide du modèle d'application Web moderne à trois niveaux avec Python. Si vous utilisez un projet créé à l'aide d'un plan différent, vous pouvez toujours suivre les étapes, mais certaines informations peuvent varier, telles que l'exemple de code et la langue.

Utiliser Amazon Q pour choisir un plan lors de la création d'un projet ou de l'ajout de fonctionnalités

En tant que développeur de projet, vous pouvez collaborer avec Amazon Q, un assistant d'intelligence artificielle générative, lors de la création de nouveaux projets ou de l'ajout de composants à des projets existants. Vous pouvez fournir à Amazon Q les exigences relatives à votre projet en interagissant avec celui-ci via une interface de type chat. Sur la base de vos besoins, Amazon Q suggère un plan et décrit également les exigences qui ne peuvent pas être satisfaites. Si votre espace possède des plans personnalisés, Amazon Q en prend connaissance et inclut également ces plans dans les recommandations. Vous pouvez ensuite suivre la suggestion d'Amazon Q si vous êtes satisfait, et celui-ci créera les ressources nécessaires, telles qu'un référentiel de sources contenant le code correspondant à vos besoins. Amazon Q crée également des problèmes liés aux exigences qui ne peuvent pas être satisfaites avec un plan. Pour en savoir plus sur les CodeCatalyst plans disponibles, consultezCréation d'un projet complet avec des CodeCatalyst plans. Pour en savoir plus sur l'utilisation d'Amazon Q avec des plans, consultezBonnes pratiques lors de l'utilisation d'Amazon Q pour créer des projets ou ajouter des fonctionnalités à l'aide de plans.

Pour créer un projet avec Amazon Q

  1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

  2. Dans la CodeCatalyst console, accédez à l'espace dans lequel vous souhaitez créer un plan.

  3. Sur le tableau de bord de l'espace, choisissez Create with Amazon Q.

  4. Dans le champ de saisie de texte d'invite Amazon Q, fournissez des instructions en rédigeant une brève description du projet que vous souhaitez créer. Par exemple, “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data.”

    (Facultatif) Sous Exemples d'essai, vous pouvez utiliser une invite préécrite en choisissant un plan. Par exemple, si vous choisissez l'application React, l'invite suivante s'affiche : “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data. I also want to add authentication and authorization mechanisms for security and allowable actions.”

  5. Choisissez Envoyer pour envoyer vos instructions à Amazon Q. L'assistant d'IA générative fournit une suggestion et décrit les exigences auxquelles le plan ne peut pas répondre. Par exemple, Amazon Q peut suggérer ce qui suit en fonction de vos critères :

    I recommend using the Modern three-tier web application blueprint based on 
                    your requirements. Blueprints are dynamic and can always be updated and edited later.

Modern three-tier web application
By Amazon Web Services

This blueprint creates a Mythical Mysfits 3-tier web application with a modular presentation, application, and data layers. 
The application leverages containers, infrastructure as code (IaC), continuous integration and continuous delivery (CI/CD), 
and serverless code functions.

Version: 0.1.163

View details

The following requirements could not be met so I will create issues for you.
• Add authentication and authorization mechanisms for security and allowable actions.

  6. (Facultatif) Pour afficher les détails détaillés du plan suggéré, choisissez Afficher les détails.

  7. Effectuez l’une des actions suivantes :

    1. Choisissez Oui, utilisez ce plan si vous êtes satisfait de la suggestion.

    2. Choisissez Modifier l'invite si vous souhaitez modifier l'invite.

    3. Choisissez Recommencer si vous souhaitez effacer complètement l'invite.

  8. Effectuez l’une des actions suivantes :

    1. Choisissez Configurer si vous souhaitez configurer le plan suggéré. Vous pouvez également configurer le plan ultérieurement.

    2. Choisissez Ignorer si vous ne souhaitez pas modifier les configurations du plan pour le moment.

  9. Si vous avez choisi de configurer le plan, choisissez Continuer après avoir modifié les ressources du projet.

  10. Lorsque vous y êtes invité, entrez le nom que vous souhaitez attribuer à votre projet et les noms des ressources associées. Le nom doit être unique dans votre espace.

  11. Choisissez Créer un projet pour créer un projet avec le plan. Amazon Q crée des ressources à l'aide du plan. Par exemple, si vous créez un projet avec le plan d'application d'une seule page, un référentiel source pour le code pertinent et les flux de travail pour le CI/CD est créé.

  12. (Facultatif) Par défaut, Amazon Q crée également des problèmes liés aux exigences qui ne sont pas satisfaites par un plan. Vous pouvez choisir les éléments pour lesquels vous ne souhaitez pas créer de problèmes. Après avoir choisi de laisser Amazon Q créer des problèmes, vous pouvez également attribuer un problème à Amazon Q. Il analysera le problème dans le contexte des référentiels sources donnés, en fournissant un résumé des fichiers sources et du code pertinents. Pour plus d’informations, consultez Recherche et affichage des problèmes, Créez un problème et attribuez-le à Amazon Q et Bonnes pratiques lors de la création et du traitement des problèmes assignés à Amazon Q.

Après avoir créé un projet avec Amazon Q, vous pouvez également utiliser Amazon Q pour ajouter de nouveaux composants, car il suggère des CodeCatalyst plans en fonction de vos besoins.

Pour ajouter un plan avec Amazon Q

  1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

  2. Dans la CodeCatalyst console, accédez au projet dans lequel vous souhaitez ajouter un plan.

  3. Choisissez Ajouter avec Amazon Q.

  4. Dans le champ de saisie de texte d'invite Amazon Q, fournissez des instructions en rédigeant une brève description du projet que vous souhaitez créer. Par exemple, “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data.”

    (Facultatif) Sous Exemples d'essai, vous pouvez utiliser une invite préécrite en choisissant un plan. Par exemple, si vous choisissez l'application React, l'invite suivante s'affiche : “I want to create a project in Python that has a presentation layer responsible for how the data is presented, an application layer that contains the core logic and functionality of the application, and a data layer that manages the storage and retrieval of the data. I also want to add authentication and authorization mechanisms for security and allowable actions.”

  5. Choisissez Envoyer pour envoyer vos instructions à Amazon Q. L'assistant d'IA générative fournit une suggestion et décrit les exigences auxquelles le plan ne peut pas répondre. Par exemple, Amazon Q peut suggérer ce qui suit en fonction de vos critères :

    I recommend using the Single-page application blueprint based on your requirements. Blueprints are dynamic and can always be updated and edited later.

Single-page application
By Amazon Web Services

This blueprint creates a SPA (single-page application) using React, Vue, or Angular frameworks and deploys to AWS Amplify Hosting.

Version: 0.2.15
View details

The following requirements could not be met so I will create issues for you.
• The application should have reusable UI components
• The application should support for client-side routing
• The application may require server-side rendering for improved performance and SEO

  6. (Facultatif) Pour afficher les détails détaillés du plan suggéré, choisissez Afficher les détails.

  7. Effectuez l’une des actions suivantes :

    1. Choisissez Oui, utilisez ce plan si vous êtes satisfait de la suggestion.

    2. Choisissez Modifier l'invite si vous souhaitez modifier l'invite.

    3. Choisissez Recommencer si vous souhaitez effacer complètement l'invite.

  8. Effectuez l’une des actions suivantes :

    1. Choisissez Configurer si vous souhaitez configurer le plan suggéré. Vous pouvez également configurer le plan ultérieurement.

    2. Choisissez Ignorer si vous ne souhaitez pas modifier les configurations du plan pour le moment.

  9. Si vous avez choisi de configurer le plan, choisissez Continuer après avoir modifié les ressources du projet.

  10. Choisissez Ajouter au projet pour ajouter des ressources à un projet avec le plan. Amazon Q crée des ressources à l'aide du plan. Par exemple, si vous ajoutez à un projet avec le plan d'application d'une seule page, un référentiel source pour le code pertinent et les flux de travail pour le CI/CD est créé.

  11. (Facultatif) Par défaut, Amazon Q crée également des problèmes liés aux exigences qui ne sont pas satisfaites par un plan. Vous pouvez choisir les éléments pour lesquels vous ne souhaitez pas créer de problèmes. Après avoir choisi de laisser Amazon Q créer des problèmes, vous pouvez également attribuer un problème à Amazon Q. Il analysera le problème dans le contexte des référentiels sources donnés, en fournissant un résumé des fichiers sources et du code pertinents. Pour plus d’informations, consultez Créez un problème et attribuez-le à Amazon Q et Bonnes pratiques lors de la création et du traitement des problèmes assignés à Amazon Q.

Créez un résumé des modifications de code entre les branches lors de la création d'une pull request

Une pull request est le principal moyen pour vous et les autres membres du projet de consulter, commenter et fusionner les modifications de code d'une branche à l'autre. Vous pouvez utiliser des pull requests pour examiner les modifications de code de manière collaborative afin de détecter des modifications ou des correctifs mineurs, des ajouts de fonctionnalités majeures ou de nouvelles versions de vos logiciels publiés. Le résumé des modifications du code et de l'intention qui sous-tend ces modifications dans le cadre de la description de la pull request est utile aux personnes qui examineront le code, et permet également de comprendre l'historique des modifications apportées au code au fil du temps. Cependant, les développeurs s'appuient souvent sur leur code pour s'expliquer ou pour fournir des détails ambigus plutôt que de décrire leurs modifications avec suffisamment de détails pour que les réviseurs puissent comprendre ce qu'ils examinent ou quelle était l'intention qui sous-tend les modifications apportées au code.

Vous pouvez utiliser la fonctionnalité Rédiger une description pour moi lorsque vous créez des pull requests pour qu'Amazon Q crée une description des modifications contenues dans une pull request. Lorsque vous choisissez cette option, Amazon Q analyse les différences entre la branche source contenant les modifications de code et la branche de destination dans laquelle vous souhaitez fusionner ces modifications. Il crée ensuite un résumé de ces modifications, ainsi que sa meilleure interprétation de l'intention et de l'effet de ces modifications.

Note

Cette fonctionnalité ne fonctionne pas avec les sous-modules Git. Il ne résumera aucune modification apportée à un sous-module Git inclus dans la pull request.

Cette fonctionnalité n'est pas disponible pour les pull requests dans les référentiels liés.

Vous pouvez essayer cette fonctionnalité avec n'importe quelle pull request que vous créez, mais dans ce didacticiel, nous allons la tester en apportant quelques modifications simples au code contenu dans un projet créé dans un plan d'application Web moderne à trois niveaux basé sur Python.

Astuce

Si vous utilisez un projet créé avec un plan différent ou votre propre code, vous pouvez toujours suivre ce didacticiel, mais les exemples de ce didacticiel ne correspondront pas au code de votre projet. Au lieu de suivre l'exemple suggéré ci-dessous, apportez de simples modifications au code de votre projet dans une branche, puis créez une pull request pour tester la fonctionnalité, comme indiqué dans les étapes suivantes.

Tout d'abord, vous allez créer une branche dans le référentiel source. Vous allez ensuite modifier rapidement le code d'un fichier de cette branche à l'aide de l'éditeur de texte de la console. Vous allez ensuite créer une pull request et utiliser la fonctionnalité Rédiger une description pour moi pour résumer les modifications que vous avez apportées.

Pour créer une branche (console)

  1. Dans la CodeCatalyst console, accédez au projet dans lequel se trouve votre référentiel source.

  2. Choisissez le nom du référentiel dans la liste des référentiels sources du projet. Dans le volet de navigation, vous pouvez également choisir Code, puis Référentiels sources.

  3. Choisissez le référentiel dans lequel vous souhaitez créer une branche.

  4. Sur la page d'aperçu du référentiel, choisissez Plus, puis sélectionnez Créer une branche.

  5. Entrez le nom de la branche.

  6. Choisissez une branche à partir de laquelle créer la branche, puis choisissez Create.

Une fois que vous avez une branche, modifiez un fichier dans cette branche par une simple modification. Dans cet exemple, vous allez modifier le test_endpoint.py fichier pour faire passer le nombre de tentatives de test 3 à 5.

Astuce

Vous pouvez également choisir de créer ou d'utiliser un environnement de développement pour effectuer cette modification de code. Pour plus d’informations, consultez Création d'un environnement de développement.

Pour modifier le test_endpoint.py fichier dans la console

  1. Sur la page d'aperçu du référentiel mysfits source, choisissez la liste déroulante des branches et choisissez la branche que vous avez créée lors de la procédure précédente.

  2. Dans Fichiers, accédez au fichier que vous souhaitez modifier. Par exemple, pour modifier le test_endpoint.py fichier, développez les tests, développez l'entier, puis choisisseztest_endpoint.py.

  3. Choisissez Modifier.

  4. À la ligne 7, modifiez le nombre de fois où tous les tests seront réessayés :

    def test_list_all(retry=3):

    par :

    def test_list_all(retry=5):

  5. Choisissez Commit et validez vos modifications dans votre branche.

Maintenant que vous avez une branche modifiée, vous pouvez créer une pull request.

Créez une pull request avec un résumé des modifications

  1. Sur la page de présentation du référentiel, choisissez Plus, puis Create pull request.

  2. Dans Branche de destination, choisissez la branche dans laquelle vous souhaitez fusionner le code une fois celui-ci révisé.

    Astuce

    Choisissez la branche à partir de laquelle vous avez créé votre branche dans la procédure précédente pour une démonstration la plus simple de cette fonctionnalité. Par exemple, si vous avez créé votre branche à partir de la branche par défaut du dépôt, choisissez cette branche comme branche de destination pour votre pull request.

  3. Dans Branche source, choisissez la branche qui contient les modifications que vous venez de valider dans le test_endpoint.py fichier.

  4. Dans Titre de la demande d'extraction, entrez un titre qui aide les autres utilisateurs à comprendre ce qui doit être revu et pourquoi.

  5. Dans Description de la pull request, choisissez Write description for me pour qu'Amazon Q crée une description des modifications contenues dans la pull request.

  6. Un résumé des modifications s'affiche. Passez en revue le texte suggéré, puis choisissez Accepter et ajouter à la description.

  7. Modifiez éventuellement le résumé pour mieux refléter les modifications que vous avez apportées au code. Vous pouvez également choisir d'ajouter des réviseurs ou de lier des problèmes à cette pull request. Lorsque vous avez terminé d'apporter les modifications supplémentaires souhaitées, choisissez Créer.

Créez un résumé des commentaires laissés sur les modifications de code dans une pull request

Lorsque les utilisateurs examinent une pull request, ils laissent souvent plusieurs commentaires sur les modifications apportées à cette pull request. S'il y a beaucoup de commentaires de la part de nombreux réviseurs, il peut être difficile de sélectionner des thèmes communs dans les commentaires, ou même de s'assurer que vous avez examiné tous les commentaires dans toutes les révisions. Vous pouvez utiliser la fonctionnalité Créer un résumé des commentaires pour qu'Amazon Q analyse tous les commentaires laissés sur les modifications de code dans une pull request et crée un résumé de ces commentaires.

Note

Les résumés des commentaires sont éphémères. Si vous actualisez une pull request, le résumé disparaît. Les résumés de contenu n'incluent pas de commentaires sur l'ensemble de la pull request, mais uniquement des commentaires laissés sur les différences de code dans les révisions de la pull request.

Cette fonctionnalité ne fonctionne pas avec les commentaires laissés sur les modifications de code dans les sous-modules Git.

Cette fonctionnalité n'est pas disponible pour les pull requests dans les référentiels liés.

Pour créer un résumé des commentaires dans une pull request

  1. Accédez à la pull request que vous avez créée lors de la procédure précédente.

    Astuce

    Si vous préférez, vous pouvez utiliser n'importe quelle pull request ouverte dans votre projet. Dans la barre de navigation, choisissez Code, choisissez Pull requests et choisissez n'importe quelle pull request ouverte.

  2. Ajoutez quelques commentaires à la pull request dans Changes si la pull request ne contient pas déjà de commentaires.

  3. Dans Vue d'ensemble, choisissez Créer un résumé des commentaires. Une fois terminée, la section Récapitulatif des commentaires s'agrandit.

  4. Consultez le résumé des commentaires laissés sur les modifications du code dans les révisions de la pull request, et comparez-le aux commentaires de la pull request.

Créez un problème et attribuez-le à Amazon Q

Les équipes de développement créent des problèmes pour suivre et gérer leur travail, mais il arrive qu'un problème persiste, soit parce que l'on ne sait pas exactement qui doit y travailler, soit parce qu'il nécessite des recherches sur une partie particulière de la base de code, soit parce qu'il faut d'abord s'occuper d'autres tâches urgentes. CodeCatalyst inclut l'intégration avec Amazon Q Developer Agent pour le développement de logiciels. Vous pouvez attribuer des problèmes à un assistant d'intelligence artificielle génératif appelé Amazon Q qui peut analyser un problème en fonction de son titre et de sa description. Si vous attribuez le problème à Amazon Q, celui-ci tentera de créer un projet de solution que vous pourrez évaluer. Cela peut vous aider, vous et votre équipe, à vous concentrer et à optimiser votre travail sur les problèmes qui nécessitent votre attention, tandis qu'Amazon Q travaille sur une solution aux problèmes que vous ne disposez pas des ressources nécessaires pour résoudre immédiatement.

Astuce

Amazon Q est le plus performant pour résoudre les problèmes simples et directs. Pour de meilleurs résultats, utilisez un langage simple pour expliquer clairement ce que vous voulez faire.

Lorsque vous attribuez un problème à Amazon Q, CodeCatalyst celui-ci est marqué comme bloqué jusqu'à ce que vous confirmiez la manière dont vous souhaitez qu'Amazon Q le traite. Vous devez répondre à trois questions avant de pouvoir continuer :

  • Que vous souhaitiez confirmer chaque étape ou que vous souhaitiez qu'elle se poursuive sans commentaires. Si vous choisissez de confirmer chaque étape, vous pouvez répondre à Amazon Q avec des commentaires sur l'approche créée afin qu'il puisse répéter son approche si nécessaire. Amazon Q peut également consulter les commentaires des utilisateurs sur toute pull request qu'il crée si vous choisissez cette option. Si vous choisissez de ne pas confirmer chaque étape, Amazon Q peut terminer son travail plus rapidement, mais il ne prendra pas en compte les commentaires que vous lui ferez dans le cadre du problème ou des pull request qu'il crée.

  • Si vous souhaitez l'autoriser à mettre à jour les fichiers de flux de travail dans le cadre de son travail. Les flux de travail de votre projet sont peut-être configurés pour démarrer des exécutions lors d'événements de pull request. Dans ce cas, toute pull request créée par Amazon Q qui inclut la création ou la mise à jour d'un flux de travail YAML peut démarrer une exécution des flux de travail inclus dans la pull request. Il est recommandé de ne pas autoriser Amazon Q à travailler sur des fichiers de flux de travail, sauf si vous êtes certain qu'aucun flux de travail de votre projet n'exécutera automatiquement ces flux de travail avant de consulter et d'approuver la pull request qu'il crée.

  • Si vous souhaitez l'autoriser à suggérer la création de tâches pour décomposer le travail lié au problème en tranches plus petites qui peuvent être attribuées individuellement aux utilisateurs, y compris Amazon Q lui-même. Permettre à Amazon Q de suggérer et de créer des tâches peut contribuer à accélérer le développement de problèmes complexes en permettant à plusieurs personnes de travailler sur des parties distinctes du problème. Cela peut également aider à réduire la complexité liée à la compréhension de l'ensemble du travail, car le travail nécessaire pour accomplir chaque tâche est idéalement plus simple que le problème auquel elle appartient.

  • Dans quel référentiel source souhaitez-vous qu'il fonctionne. Même si votre projet possède plusieurs référentiels de sources, Amazon Q ne peut travailler que sur le code d'un seul référentiel de sources. Les référentiels liés ne sont pas pris en charge.

Une fois que vous avez fait et confirmé vos choix, Amazon Q place le problème dans l'état En cours pendant qu'il tente de déterminer la nature de la demande en fonction du titre du problème et de sa description, ainsi que du code contenu dans le référentiel spécifié. Il créera un commentaire épinglé dans lequel il fournira des mises à jour sur l'état de ses travaux. Après avoir examiné les données, Amazon Q formulera une approche potentielle pour trouver une solution. Amazon Q enregistre ses actions en mettant à jour son commentaire épinglé et en commentant l'évolution du problème à chaque étape. Contrairement aux commentaires et réponses épinglés, il ne conserve pas une trace strictement chronologique de ses travaux. Il place plutôt les informations les plus pertinentes sur son travail au niveau supérieur du commentaire épinglé. Il tentera de créer du code en fonction de son approche et de son analyse du code déjà présent dans le référentiel. S'il parvient à générer une solution potentielle, il créera une branche et validera le code à cette branche. Il crée ensuite une pull request qui fusionnera cette branche avec la branche par défaut. Lorsque Amazon Q a terminé son travail, il place le problème dans En cours de révision afin que vous et votre équipe sachiez qu'un code est prêt à être évalué.

Note

Cette fonctionnalité est uniquement disponible via Issues in the USA West (Oregon) Region. Il n'est pas disponible si vous avez configuré votre projet pour utiliser Jira avec l'extension Jira Software. De plus, si vous avez personnalisé la mise en page de votre tableau, il est possible que le problème ne change pas d'état. Pour de meilleurs résultats, n'utilisez cette fonctionnalité qu'avec des projets dotés d'une disposition de tableau standard.

Cette fonctionnalité ne fonctionne pas avec les sous-modules Git. Il ne peut pas modifier les sous-modules Git inclus dans le dépôt.

Une fois que vous avez attribué un problème à Amazon Q, vous ne pouvez pas modifier le titre ou la description du problème, ni l'attribuer à quelqu'un d'autre. Si vous annulez l'attribution du problème à Amazon Q, celui-ci terminera l'étape en cours, puis cessera de fonctionner. Il ne peut pas reprendre le travail ni être réaffecté au problème une fois qu'il a été annulé.

Un problème peut être automatiquement déplacé dans la colonne En cours d'examen s'il est attribué à Amazon Q si un utilisateur choisit de l'autoriser à créer des tâches. Cependant, le problème dans En cours de révision peut toujours comporter des tâches dans un état différent, par exemple dans l'état En cours.

Dans cette partie du didacticiel, vous allez créer trois problèmes basés sur les fonctionnalités potentielles du code inclus dans les projets créés avec le modèle d'application Web moderne à trois niveaux : un pour ajouter un pour créer une nouvelle créature Mysfit, un pour ajouter une fonctionnalité de tri et un pour mettre à jour un flux de travail afin d'inclure une branche nommée. test

Note

Si vous travaillez sur un projet avec un code différent, créez des problèmes avec les titres et les descriptions liés à cette base de code.

Pour créer un problème et obtenir une solution à évaluer

  1. Dans le volet de navigation, choisissez Problèmes et assurez-vous que vous êtes dans la vue Tableau.

  2. Choisissez Créer un problème.

  3. Donnez au numéro un titre qui explique ce que vous voulez faire dans un langage simple. Par exemple, pour ce numéro, entrez le titre deCreate another mysfit named Quokkapus. Dans Description, fournissez les informations suivantes :

    Expand the table of mysfits to 13, and give the new mysfit the following characteristics:

Name: Quokkapus

Species: Quokka-Octopus hybrid

Good/Evil: Good

Lawful/Chaotic: Chaotic

Age: 216

Description: Australia is full of amazing marsupials, but there's nothing there quite like the Quokkapus. 
She's always got a friendly smile on her face, especially when she's using her eight limbs to wrap you up 
in a great big hug. She exists on a diet of code bugs and caffeine. If you've got some gnarly code that needsa
assistance, adopt Quokkapus and put her to work - she'll love it! Just make sure you leave enough room for 
her to grow, and keep that coffee coming.

  4. (Facultatif) Joignez une image à utiliser comme miniature et photo de profil pour le MysFit to the Issue. Dans ce cas, mettez à jour la description pour inclure des détails sur les images que vous souhaitez utiliser et pourquoi. Par exemple, vous pouvez ajouter ce qui suit à la description : « Le Mysfit nécessite le déploiement de fichiers image sur le site Web. Ajoutez ces images jointes à ce numéro au référentiel source dans le cadre du travail, et déployez-les sur le site Web. »

    Note

    Les images jointes peuvent ou non être déployées sur le site Web lors des interactions de ce didacticiel. Vous pouvez ajouter vous-même les images au site Web, puis laisser des commentaires pour qu'Amazon Q mette à jour son code afin qu'il pointe vers les images que vous souhaitez qu'il utilise une fois qu'il a créé une pull request.

    Passez en revue la description et assurez-vous qu'elle contient tous les détails nécessaires avant de passer à l'étape suivante.

  5. Dans Destinataires, choisissez Attribuer à Amazon Q.

  6. Dans Référentiel source, choisissez le référentiel source qui contient le code du projet.

  7. Faites glisser le bouton Require Amazon Q pour qu'il s'arrête après chaque étape et attendez que son sélecteur de travail passe à l'état actif si nécessaire.

    Note

    Choisir l'option d'arrêt d'Amazon Q après chaque étape vous permet de commenter le problème ou les tâches créées. Vous avez ainsi la possibilité de demander à Amazon Q de modifier son approche jusqu'à trois fois en fonction de vos commentaires. Si vous choisissez de ne pas arrêter Amazon Q après chaque étape afin de pouvoir passer en revue son travail, le travail progressera peut-être plus rapidement car Amazon Q n'attend pas vos commentaires, mais vous ne serez pas en mesure d'influencer l'orientation d'Amazon Q en laissant des commentaires. Amazon Q ne répondra pas non plus aux commentaires laissés dans une pull request si vous choisissez cette option.

  8. Laissez le sélecteur Autoriser Amazon Q à modifier les fichiers de flux de travail à l'état inactif.

  9. Faites glisser le sélecteur Autoriser Amazon Q pour suggérer la création de tâches sur l'état actif.

  10. Choisissez Créer un problème. Votre point de vue change sur le tableau des problèmes.

  11. Choisissez Créer un numéro pour créer un autre numéro, cette fois avec le titreChange the get_all_mysfits() API to return mysfits sorted by the Age attribute. Attribuez ce problème à Amazon Q et créez-le.

  12. Choisissez Créer un numéro pour créer un autre numéro, cette fois avec le titreUpdate the OnPullRequest workflow to include a branch named test in its triggers. Vous pouvez éventuellement créer un lien vers le flux de travail dans la description. Attribuez ce problème à Amazon Q, mais assurez-vous cette fois que le sélecteur Autoriser Amazon Q à modifier les fichiers de flux de travail est défini sur l'état actif. Créez le problème pour revenir au tableau des problèmes.

    Astuce

    Vous pouvez rechercher des fichiers, y compris des fichiers de flux de travail, en saisissant le symbole arobase (@) et en saisissant le nom du fichier.

Une fois que vous avez créé et attribué les problèmes, ils seront placés dans En cours. Amazon Q ajoutera des commentaires permettant de suivre l'évolution du problème dans un commentaire épinglé. S'il est en mesure de définir une approche pour une solution, il mettra à jour la description du problème avec une section Contexte contenant son analyse de la base de code et une section Approche détaillant l'approche proposée pour créer une solution. Si Amazon Q parvient à trouver une solution au problème décrit dans le problème, il créera une branche et modifiera le code dans cette branche afin de mettre en œuvre la solution proposée. Si le code proposé présente des similitudes avec le code source ouvert dont Amazon Q a connaissance, il fournira un fichier contenant des liens vers ce code afin que vous puissiez le consulter. Une fois que le code est prêt, il crée une pull request afin que vous puissiez consulter les modifications de code suggérées, ajoute un lien vers cette pull request au problème et place le problème dans En révision.

Important

Vous devez toujours examiner les modifications de code dans une pull request avant de la fusionner. Les modifications de code de fusion effectuées par Amazon Q, comme toute autre modification de code, peuvent avoir un impact négatif sur votre code de base et votre code d'infrastructure si le code fusionné n'est pas correctement examiné et contient des erreurs lors de la fusion.

Pour examiner un problème et une pull request associée contenant des modifications apportées par Amazon Q

  1. Dans Problèmes, choisissez un problème en cours attribué à Amazon Q. Consultez les commentaires pour suivre l'évolution d'Amazon Q. Si c'est le cas, examinez le contexte et abordez les informations enregistrées dans la description du problème. Si vous avez choisi d'autoriser Amazon Q à suggérer des tâches, passez en revue les tâches proposées et prenez les mesures nécessaires. Par exemple, si Amazon Q suggère des tâches et que vous souhaitez modifier l'ordre ou attribuer des tâches à des utilisateurs spécifiques, choisissez Modifier, ajouter ou réorganiser les tâches et effectuez les mises à jour nécessaires. Lorsque vous avez fini de consulter le problème, choisissez X pour fermer le volet des problèmes.

    Astuce

    Pour voir l'avancement des tâches, choisissez la tâche dans la liste des tâches du numéro. Les tâches n'apparaissent pas séparément sur le tableau et ne sont accessibles qu'en cas de problème. Si une tâche est affectée à Amazon Q, vous devez ouvrir la tâche pour approuver les actions qu'elle souhaite effectuer. Vous devez également ouvrir une tâche pour voir les pull requests associées, car elles n'apparaîtront pas sous forme de liens dans le numéro, mais uniquement dans la tâche. Pour revenir à un problème à partir d'une tâche, cliquez sur le lien vers le problème.

  2. Choisissez maintenant un problème attribué à Amazon Q qui est en cours de révision. Passez en revue le contexte et abordez l'approche qu'il enregistre dans la description du problème. Passez en revue les commentaires pour comprendre les actions qu'il a effectuées. Passez en revue toutes les tâches créées pour le travail lié à ce problème, y compris leur progression, les mesures que vous pourriez avoir à prendre et les commentaires éventuels. Dans Pull requests, choisissez le lien vers la pull request à côté de l'étiquette Open pour vérifier le code.

    Astuce

    Les pull requests générées pour les tâches apparaissent uniquement sous forme de pull requests liées dans la vue des tâches. Elles n'apparaissent pas sous forme de pull requests liées au problème.

  3. Dans la pull request, passez en revue les modifications apportées au code. Pour plus d’informations, consultez Révision d'une pull request. Laissez des commentaires sur la pull request si vous souhaitez qu'Amazon Q modifie l'un des codes suggérés. Soyez précis lorsque vous laissez des commentaires pour Amazon Q pour de meilleurs résultats.

    Par exemple, lorsque vous examinez la pull request créée pourCreate another mysfit named Quokkapus, vous remarquerez peut-être une faute de frappe dans la description. Vous pouvez laisser un commentaire pour Amazon Q indiquant « Modifiez la description pour corriger la faute de frappe « needsa » en ajoutant un espace entre « needs » et « a » ». Vous pouvez également laisser un commentaire demandant à Amazon Q de mettre à jour la description et de fournir l'intégralité de la description révisée afin qu'elle soit incorporée.

    Si vous avez chargé des images du nouveau Mysfit sur le site Web, vous pouvez laisser un commentaire pour qu'Amazon Q mette à jour le Mysfit avec des pointeurs vers l'image et la miniature à utiliser pour le nouveau Mysfit.

    Note

    Amazon Q ne répondra pas aux commentaires individuels. Amazon Q n'intégrera les commentaires laissés dans les commentaires des pull requests que si vous avez choisi l'option par défaut qui consiste à arrêter après chaque étape d'approbation lors de la création du problème.

  4. (Facultatif) Une fois que vous et les autres utilisateurs du projet avez laissé tous les commentaires souhaités concernant les modifications du code, choisissez Create revision pour qu'Amazon Q crée une révision de la pull request qui intègre les modifications que vous avez demandées dans les commentaires. La progression de la création de révisions sera signalée par Amazon Q dans la section Vue d'ensemble, et non dans la section Modifications. Assurez-vous d'actualiser votre navigateur pour consulter les dernières mises à jour d'Amazon Q concernant la création de la révision.

    Note

    Seul l'utilisateur qui a créé le problème peut créer une révision de la pull request. Vous ne pouvez demander qu'une seule révision d'une pull request. Assurez-vous d'avoir résolu tous les problèmes liés aux commentaires et d'être satisfait du contenu des commentaires avant de choisir Créer une révision.

  5. Un flux de travail est exécuté pour chaque pull request dans cet exemple de projet. Assurez-vous qu'un flux de travail s'exécute correctement avant de fusionner la pull request. Vous pouvez également choisir de créer des flux de travail et des environnements supplémentaires pour tester le code avant de le fusionner. Pour plus d’informations, consultez Commencer à utiliser les flux de travail.

  6. Lorsque vous êtes satisfait de la dernière révision de la pull request, choisissez Merge.

Créez un problème et demandez à Amazon Q de vous recommander des tâches à ce sujet

Un problème peut parfois nécessiter une charge de travail complexe ou longue. CodeCatalyst inclut l'intégration avec Amazon Q Developer Agent pour le développement de logiciels. Vous pouvez demander à Amazon Q d'analyser un problème en fonction de son titre et de sa description, et de recommander une répartition logique du travail en tâches distinctes. Il tentera de créer une liste de tâches recommandées qui pourra ensuite être revue, modifiée et choisir de créer ou non. Cela peut vous aider, vous et votre équipe, à attribuer des parties individuelles du travail aux utilisateurs de manière plus facile à gérer et à réaliser plus rapidement.

Pour créer et consulter une liste de tâches recommandées pour un problème

  1. Dans le volet de navigation, choisissez Problèmes et assurez-vous que vous êtes dans la vue Tableau.

  2. Choisissez Créer un problème.

  3. Donnez au numéro un titre qui explique ce que vous voulez faire dans un langage simple. Par exemple, pour ce numéro, entrez le titre deChange the get_all_mysfits() API to return mysfits sorted by the Good/Evil attribute. Dans Description, fournissez les informations suivantes :

    Update the API to allow sorting of mysfits by whether they are Good, Neutral, or Evil. Add a button on the website that allows users to quickly choose this sort and to exclude alignments that they don't want to see.

  4. Passez en revue la description et assurez-vous qu'elle contient tous les détails nécessaires avant de passer à l'étape suivante.

  5. Dans Personnes assignées, choisissez de vous attribuer le problème.

  6. Choisissez Créer un problème. Votre point de vue change sur le tableau des problèmes.

  7. Choisissez le numéro que vous venez de créer pour l'ouvrir. Choisissez Recommander des tâches.

  8. Choisissez le référentiel source qui contient le code du problème. Choisissez Commencer à recommander des tâches.

La boîte de dialogue se ferme et Amazon Q commence à analyser la complexité du problème. Si le problème est complexe, il suggère de diviser le travail en tâches distinctes et séquentielles. Lorsque la liste est prête, choisissez Afficher les tâches recommandées. Vous pouvez ajouter des tâches supplémentaires, modifier les tâches recommandées et réorganiser les tâches. Si vous êtes d'accord avec les recommandations, choisissez Créer des tâches pour créer les tâches. Vous pouvez ensuite attribuer ces tâches aux utilisateurs pour qu'ils y travaillent, ou même à Amazon Q lui-même.

Nettoyage des ressources

Une fois que vous aurez terminé ce didacticiel, envisagez de prendre les mesures suivantes pour nettoyer les ressources que vous avez créées au cours de ce didacticiel et dont vous n'avez plus besoin.

  • Annulez l'attribution à Amazon Q de tous les problèmes qui ne sont plus résolus. Si Amazon Q a terminé son travail sur un problème ou n'a pas trouvé de solution, veillez à annuler l'attribution d'Amazon Q afin d'éviter d'atteindre le quota maximum pour les fonctionnalités d'IA génératives. Pour plus d'informations, consultez Gestion des fonctionnalités d'IA générative et tarification.

  • Déplacez tous les problèmes pour lesquels le travail est terminé vers Terminé.

  • Si le projet n'est plus nécessaire, supprimez-le.