Funzionalità

Pull Request

Genera Pull Request e descrizioni PR direttamente dalla tua IDE. Bob analizza le modifiche, crea descrizioni dettagliate e ottimizza il tuo flusso di lavoro.

Perché utilizzare questa funzionalità?

  • Risparmiare tempo: Genera automaticamente descrizioni PR dettagliate basate sulle tue modifiche.
  • Mantenere la coerenza: Assicurati che tutte le PR seguano un formato coerente.
  • Migliorare la collaborazione: Fornisci ai revisori un contesto chiaro con descrizioni ben strutturate.
  • Ottimizzare il flusso di lavoro: Crea PR senza lasciare la tua IDE.

Come funziona

Bob analizza le modifiche del tuo branch, la cronologia dei commit e il nome del branch per comprendere lo scopo e l'ambito del tuo lavoro. Genera quindi un titolo PR significativo e una descrizione dettagliata che riassume le tue modifiche, rendendo più facile per i revisori comprendere il contesto e lo scopo della tua PR. Dopo la generazione, puoi rivedere e modificare la descrizione della PR prima dell'invio.

Il processo di generazione della PR è interattivo, permettendoti di selezionare il branch di destinazione e il repository remoto prima di creare la PR.

Iniziare

Prerequisiti

  • Le tue modifiche devono essere committate in un branch.
  • Devi avere accesso push al repository remoto.

Utilizzo base

Puoi scegliere tra 3 opzioni per avviare un flusso PR:

  • Fai clic sull'icona PR nel pannello Source Control.
  • Usa la palette dei comandi (Cmd + Shift + P su Mac, Ctrl + Shift + P su Windows/Linux) e cerca "Bob: Generate PR".
  • Digita /create-pr nell'interfaccia chat di Bob.

Bob ti guiderà quindi attraverso i seguenti passaggi:

  1. Seleziona il branch base in cui desideri effettuare il merge. Bob suggerisce i tre branch più probabili.
  2. Seleziona il repository remoto se hai più remote.
  3. Rivedi la descrizione e il titolo della PR generati.
  4. Crea la PR.
  5. Ricevi il link alla PR appena creata nella tua chat.

Utilizzo dei template per le descrizioni PR

Bob riconosce e utilizza automaticamente i template PR esistenti del tuo progetto durante la generazione delle descrizioni delle Pull Request. Questo assicura che le tue PR siano coerenti con gli standard stabiliti del tuo team. Se Bob rileva più template PR nel tuo progetto, puoi selezionare quale template applicare alla tua Pull Request.

Rilevamento dei template

Bob cerca i template PR nelle seguenti posizioni relative alla radice del tuo progetto:

  1. ${cwd}/pull_request_template.md
  2. ${cwd}/docs/pull_request_template.md
  3. ${cwd}/.github/pull_request_template.md
  4. ${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
  5. ${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
  6. ${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

Se Bob trova più template, chiederà all'utente di selezionare quale template utilizzare per la descrizione della PR.

Template predefinito

Se non viene trovato alcun template nel tuo progetto, Bob utilizza un template integrato che include:

  • Un titolo descrittivo derivato dal nome del tuo branch
  • Un riepilogo delle modifiche
  • Dettagli di implementazione chiave
  • Informazioni sui test
  • Eventuali link o riferimenti rilevanti

Modificare la descrizione generata

Dopo aver generato la descrizione della PR, Bob la presenta direttamente nella chat. Puoi quindi:

  • Confermare e continuare: Approva la descrizione così com'è per procedere con la creazione della PR.
  • Richiedere modifiche: Scrivi il tuo feedback nella chat e Bob rigenererà la descrizione in base alle tue indicazioni. Puoi iterare tutte le volte necessarie prima di confermare.

Personalizzare i template

Per i migliori risultati con la generazione PR di Bob:

  • Usa intestazioni di sezione chiare nei tuoi template (ad es. ## Riepilogo, ## Modifiche)
  • Includi testo segnaposto che fornisce contesto (ad es. <!-- Descrivi lo scopo di questa PR -->)
  • Considera l'aggiunta di sezioni per istruzioni di test e problemi correlati

Suggerimenti e best practice

  • Usa nomi di branch descrittivi per aiutare Bob a generare descrizioni PR più accurate.
  • Rivedi e modifica la descrizione generata prima di creare la PR.
Come valuti questo argomento?