Revisione del codice con Amazon Q Developer in GitHub - Amazon Q Developer
PrerequisitiAvvio delle revisioni del codice per le richieste pull di GitHubAvvio delle revisioni del codice all’interno delle richieste pull di GitHub

Revisione del codice con Amazon Q Developer in GitHub

Nota

Amazon Q Developer per GitHub è disponibile nella versione di anteprima ed è soggetto a modifiche.

Amazon Q Developer abilita revisioni automatiche del codice all’interno di GitHub. Quando crei una nuova richiesta pull o ne riapri una chiusa, Amazon Q Developer esegue automaticamente una revisione del codice e fornisce feedback sulla qualità del codice, sui potenziali problemi e sugli esiti di elevata gravità. Ogni revisione include un riepilogo sulla revisione del codice con esiti suddivisi in thread. Amazon Q Developer genera inoltre delle correzioni per i problemi identificati, che puoi esaminare e scegliere di inserire nella richiesta di pull. Puoi utilizzare il comando /q nei commenti delle richieste pull per porre domande e interagire in merito agli esiti della revisione del codice. Le revisioni automatiche del codice non vengono attivate dai commit successivi effettuati all’interno di una richiesta pull esistente.

È inoltre possibile avviare revisioni del codice all’interno delle richieste pull con il comando slash /q review. Il comando slash può essere aggiunto a un nuovo commento della richiesta pull, che avvia una nuova revisione del codice della richiesta pull nel suo stato attuale, inclusi eventuali commenti e nuovi commit. Per ulteriori informazioni, consulta Avvio delle revisioni del codice all’interno delle richieste pull di GitHub.

Puoi fare in modo che Amazon Q Developer esegua una revisione del codice per un numero limitato di righe al mese. Puoi aumentare l’utilizzo gratuito in qualsiasi momento registrando l’installazione dell’app Amazon Q Developer con il tuo account AWS. Per ulteriori informazioni, consulta Aumento dei limiti di utilizzo e dei dettagli di configurazione nella console Amazon Q Developer.

Nota

Se la funzionalità di revisione del codice era precedentemente disabilitata, deve essere abilitata nella console Amazon Q Developer prima di poter applicare l’etichetta GitHub. Per ulteriori informazioni, consulta Modifica delle funzionalità di Amazon Q Developer in GitHub.

Prerequisiti

Prima di poter avviare la revisione del codice con Amazon Q Developer, sono necessarie le autorizzazioni appropriate per il repository GitHub di destinazione. I ruoli del repository supportati sono Write, Maintain o Admin. Gli utenti con ruoli Read o Triage, così come i membri senza un ruolo, non possono avviare revisioni del codice con Amazon Q Developer.

Gli utenti GitHub con il ruolo Triage possono comunque esaminare le richieste pull in un repository. Qualsiasi utente, indipendentemente dal ruolo, può esaminare le richieste pull nei repository pubblici.

Per ulteriori informazioni, consulta Repository roles for organizations e About pre-defined organization roles nella documentazione di GitHub.

Avvio delle revisioni del codice per le richieste pull di GitHub

Quando apri una nuova richiesta pull o ne riapri una precedentemente chiusa, Amazon Q Developer esegue automaticamente una revisione del codice e fornisce feedback sulla qualità del codice, sui possibili problemi ed esiti critici.

Per utilizzare Amazon Q Developer per la revisione del codice e l’applicazione di correzioni

Prima di iniziare una revisione, puoi personalizzare una revisione della qualità del codice definendo standard di codifica personalizzati in semplici file Markdown nella directory project-root/.amazonq/rules. Amazon Q segue automaticamente le tue linee guida, garantendo una qualità del codice costante per l’intero progetto. Per ulteriori informazioni, consulta Creazione di regole di progetto per Amazon Q Developer in piattaforme di terze parti.

  1. Se necessario, accedi al tuo account GitHub utilizzando le credenziali GitHub.

  2. Accedi alla tua organizzazione GitHub, quindi vai al repository in cui desideri eseguire una revisione del codice con Amazon Q Developer.

  3. Crea una nuova richiesta pull per le modifiche apportate al codice sorgente. Per ulteriori informazioni, consulta Creating a pull request nella documentazione di GitHub.

    Quando crei una nuova richiesta pull, Amazon Q Developer avvia automaticamente una revisione del codice per individuare potenziali problemi. Una volta completata la revisione, Amazon Q Developer fornisce un riepilogo della revisione del codice. Ogni esito appare sotto forma di commento in thread sotto il riepilogo, insieme alle correzioni suggerite che puoi inserire nella richiesta pull.

  4. (Facoltativo) Poni domande sugli esiti specifici. All’interno della richiesta pull, accedi a Aggiungi un commento e, nel campo di immissione del testo del commento, inserisci /q seguito dalla tua domanda (ad esempio, “/q explain the importance of this finding“).

  5. Esamina le modifiche al codice proposte da Amazon Q Developer, scegli Esegui il commit del suggerimento, quindi scegli Esegui il commit delle modifiche per aggiornare la richiesta pull.

  6. Se sei soddisfatto delle correzioni al codice suggerite, puoi unire la richiesta pull per applicare le modifiche al codice suggerite da Amazon Q Developer. Per ulteriori informazioni, consulta Merging a pull request nella documentazione di GitHub.

Avvio delle revisioni del codice all’interno delle richieste pull di GitHub

Dopo una revisione automatica del codice eseguita da Amazon Q Developer per una richiesta pull GitHub nuova o riaperta, puoi avviare ulteriori revisioni del codice per iterarlo utilizzando il comando slash /q review. La revisione del codice viene eseguita sul file diff dell’intera richiesta pull.

Nota

È possibile avviare una revisione del codice all’interno di una richiesta pull solo con un nuovo commento. Il comando slash /q review non funzionerà in un thread di commenti esistente.

Per utilizzare l’avvio delle revisioni del codice in una richiesta pull

  1. Se necessario, accedi al tuo account GitHub utilizzando le credenziali GitHub.

  2. Accedi alla tua organizzazione GitHub, quindi vai alla richiesta pull in cui desideri eseguire una revisione del codice con Amazon Q Developer. Per ulteriori informazioni, consulta About pull requests.

  3. All’interno della richiesta pull, vai su Aggiungi un commento e nel campo di immissione del testo del commento, inserisci /q review.

  4. Scegli Commento per avviare la revisione del codice.

    Amazon Q Developer potrebbe richiedere alcuni minuti per completare l’analisi del codice della richiesta pull. Al termine dell’analisi, Amazon Q Developer fornisce un riepilogo di revisione del codice. Ogni esito appare sotto forma di commento in thread sotto il riepilogo, insieme alle modifiche proposte che puoi scegliere di confermare e aggiornare la richiesta pull.

  5. (Facoltativo) Poni domande sugli esiti specifici. All’interno della richiesta pull, accedi a Aggiungi un commento e, nel campo di immissione del testo del commento, inserisci /q seguito dalla tua domanda (ad esempio, “/q explain the importance of this finding“).

  6. Se sei soddisfatto delle correzioni al codice suggerite, puoi unire la richiesta pull per applicare le modifiche al codice suggerite da Amazon Q Developer. Per ulteriori informazioni, consulta Merging a pull request nella documentazione di GitHub.