Révision du code avec Amazon Q Developer dans GitHub - Amazon Q Developer
PrérequisLancement des révisions de code pour les demandes de tirage GitHubLancement des révisions de code dans le cadre des demandes de tirage GitHub

Révision du code avec Amazon Q Developer dans GitHub

Note

Amazon Q Developer pour GitHub est actuellement disponible en version préliminaire et susceptible d’être modifié.

Amazon Q Developer permet des révisions de code automatisées au sein de GitHub. Lorsque vous créez une nouvelle demande de tirage ou que vous ouvrez à nouveau une demande de tirage fermée, Amazon Q Developer effectue automatiquement une révision du code et fournit un feedback sur la qualité du code, les problèmes potentiels et les résultats de gravité élevée. Chaque révision inclut un résumé de la révision du code avec les résultats par fil de discussion. Amazon Q Developer génère également des correctifs pour les problèmes identifiés, que vous pouvez consulter et choisir de valider dans la demande de tirage. Vous pouvez utiliser la commande /q dans les commentaires de la demande de tirage pour poser des questions et interagir concernant les résultats de la révision du code. Les révisions automatiques du code ne sont pas déclenchées par les validations ultérieures effectuées dans le cadre d’une demande de tirage existante.

Vous pouvez également lancer des révisions de code dans le cadre des demandes de tirage à l’aide de la commande slash /q review. La commande slash peut être ajoutée à un nouveau commentaire de demande de tirage, ce qui lance une nouvelle révision du code de la demande de tirage dans son état actuel, y compris les commentaires et les nouvelles validations. Pour plus d’informations, consultez Lancement des révisions de code dans le cadre des demandes de tirage GitHub.

Vous pouvez demander à Amazon Q Developer d’effectuer une révision du code pour un nombre limité de lignes par mois. Vous pouvez augmenter votre utilisation gratuite à tout moment en enregistrant l’installation de l’application Amazon Q Developer avec votre compte AWS. Pour plus d’informations, consultez Augmentation des limites d’utilisation et des détails de configuration dans la console Amazon Q Developer.

Note

Si la fonctionnalité de révision du code a déjà été désactivée, elle doit être activée dans la console Amazon Q Developer pour que vous puissiez apposer l’étiquette dans GitHub. Pour plus d’informations, consultez Fonctionnalités d’édition pour Amazon Q Developer dans GitHub.

Prérequis

Avant de pouvoir lancer des révisions de code avec Amazon Q Developer, vous devez disposer des autorisations appropriées pour le référentiel GitHub cible. Les rôles de référentiel pris en charge sont l’écriture, la gestion ou l’administration. Les utilisateurs dotés de rôles de lecture ou de triage, ainsi que les membres sans rôle, ne peuvent pas lancer de révision de code avec Amazon Q Developer.

Les utilisateurs GitHub dotés du rôle de triage peuvent toujours consulter les demandes de tirage dans un référentiel. Tout utilisateur, quel que soit son rôle, peut consulter les demandes de tirage dans les référentiels publics.

Pour plus d’informations, consultez Rôles de dépôt pour des organisations et About pre-defined organization roles dans la documentation GitHub.

Lancement des révisions de code pour les demandes de tirage GitHub

Lorsque vous ouvrez une nouvelle demande de tirage ou que vous ouvrez à nouveau une demande précédemment clôturée, Amazon Q Developer effectue automatiquement une révision du code et fournit un feedback sur la qualité du code, les problèmes éventuels et les résultats critiques.

Pour utiliser Amazon Q Developer pour réviser le code et appliquer des correctifs

Avant de commencer une révision, vous pouvez personnaliser une évaluation de la qualité du code en définissant des normes de codage personnalisées dans de simples fichiers Markdown du répertoire project-root/.amazonq/rules. Amazon Q suit automatiquement vos directives, garantissant ainsi une qualité de code constante tout au long de votre projet. Pour plus d’informations, consultez Création de règles de projet pour Amazon Q Developer sur des plateformes tierces.

  1. Si nécessaire, connectez-vous à votre compte GitHub en utilisant vos informations d’identification GitHub.

  2. Accédez à votre organisation GitHub, puis au référentiel dans lequel vous souhaitez effectuer une révision de code avec Amazon Q Developer.

  3. Créez une nouvelle demande de tirage pour les modifications apportées à votre code source. Pour plus d’informations, consultez Création d’une demande de tirage dans la documentation GitHub.

    Lorsque vous créez une nouvelle demande de tirage, Amazon Q Developer lance automatiquement une révision du code afin de détecter les problèmes potentiels. Une fois qu’Amazon Q Developer a terminé la révision, il fournit un résumé de la révision du code. Chaque résultat apparaît sous forme de commentaire de fil de discussion sous le résumé, accompagné de suggestions de corrections que vous pouvez appliquer à la demande de tirage.

  4. (Facultatif) Posez des questions sur des résultats spécifiques. Dans la demande de tirage, accédez à Ajouter un commentaire, puis dans le champ de saisie du texte du commentaire, entrez /q suivi de votre question (par exemple, « /q explain the importance of this finding »).

  5. Passez en revue les modifications de code proposées par Amazon Q Developer, choisissez Valider la suggestion, puis choisissez Valider les modifications pour mettre à jour la demande de tirage.

  6. Si vous êtes satisfait des corrections de code suggérées, vous pouvez fusionner la demande de tirage pour appliquer les modifications de code suggérées par Amazon Q Developer. Pour plus d’informations, consultez Fusion d’une demande de tirage dans la documentation GitHub.

Lancement des révisions de code dans le cadre des demandes de tirage GitHub

Après une révision automatique du code effectuée par Amazon Q Developer pour une demande de tirage GitHub nouvelle ou ouverte à nouveau, vous pouvez lancer des révisions de code supplémentaires pour itérer votre code à l’aide de la commande slash /q review. La révision du code est effectuée sur l’intégralité de la vue comparative de la demande de tirage.

Note

Vous ne pouvez lancer une révision de code que dans le cadre d’une demande de tirage avec un nouveau commentaire. La commande slash /q review ne fonctionnera pas dans un fil de commentaires existant.

Pour utiliser le lancement des révisions de code dans une demande de tirage

  1. Si nécessaire, connectez-vous à votre compte GitHub en utilisant vos informations d’identification GitHub.

  2. Accédez à votre organisation GitHub, puis à la demande de tirage pour laquelle vous souhaitez effectuer une révision de code avec Amazon Q Developer. Pour plus d’informations, consultez À propos des demandes de tirage (pull requests).

  3. Dans la demande de tirage, accédez Ajouter un commentaire, puis saisissez /q review dans le champ de saisie du texte du commentaire.

  4. Choisissez Commentaire pour lancer la révision du code.

    L’analyse du code de demande de tirage par Amazon Q Developer peut prendre quelques minutes. Une fois l’analyse terminée, Amazon Q Developer fournit un résumé de la révision du code. Chaque résultat apparaît sous forme de commentaire dans un fil de discussion sous le résumé, avec les modifications proposées que vous pouvez choisir pour valider et mettre à jour la demande de tirage.

  5. (Facultatif) Posez des questions sur des résultats spécifiques. Dans la demande de tirage, accédez à Ajouter un commentaire, puis dans le champ de saisie du texte du commentaire, entrez /q suivi de votre question (par exemple, « /q explain the importance of this finding »).

  6. Si vous êtes satisfait des corrections de code suggérées, vous pouvez fusionner la demande de tirage pour appliquer les modifications de code suggérées par Amazon Q Developer. Pour plus d’informations, consultez Fusion d’une demande de tirage dans la documentation GitHub.