Gere pull requests e descrições de PR diretamente do seu IDE. Bob analisa mudanças, cria descrições detalhadas e simplifica seu fluxo de trabalho.

Por que usar este recurso?

Economize tempo: Gere descrições de PR detalhadas automaticamente baseadas nas suas mudanças.
Mantenha consistência: Garanta que todos os PRs sigam um formato consistente.
Melhore colaboração: Forneça contexto claro para revisores com descrições bem estruturadas.
Simplifique fluxo de trabalho: Crie PRs sem sair do seu IDE.

Bob analisa as mudanças do seu branch, histórico de commits e nome do branch para entender o propósito e escopo do seu trabalho. Ele então gera um título de PR significativo e descrição detalhada que resume suas mudanças, facilitando para revisores entenderem o contexto e propósito do seu PR. Após a geração, você pode revisar e editar a descrição do PR antes da submissão.

O processo de geração de PR é interativo, permitindo que você selecione o branch alvo e repositório remoto antes de criar o PR.

Começando

Pré-requisitos

Suas mudanças devem estar commitadas em um branch.
Você deve ter acesso de push ao repositório remoto.

Uso básico

Você pode escolher entre 3 opções para iniciar um fluxo de PR:

Clique no ícone PR no painel Source Control.
Use a paleta de comandos (Cmd + Shift + P no Mac, Ctrl + Shift + P no Windows/Linux) e procure por "Bob: Generate PR".
Digite /create-pr na interface de chat Bob.

Bob então guiará você através dos seguintes passos:

Selecione o branch base no qual você quer fazer merge. Bob sugerirá os três branches mais prováveis.
Selecione o repositório remoto, se você tiver múltiplos remotos.
Revise a descrição e título do PR gerados.
Crie o PR.
Obtenha o link do PR recém-criado no seu chat.

Usando templates para descrições de PR

Bob detecta e usa automaticamente os templates de PR existentes do seu projeto ao gerar descrições de pull request. Isso garante que seus PRs sejam consistentes com os padrões estabelecidos da sua equipe. Quando Bob detecta múltiplos templates de PR no seu projeto, você pode selecionar qual template aplicar ao seu pull request.

Detecção de template

Bob procura por templates de PR nos seguintes locais relativos à raiz do seu projeto:

${cwd}/pull_request_template.md
${cwd}/docs/pull_request_template.md
${cwd}/.github/pull_request_template.md
${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

Se Bob encontrar múltiplos templates, Bob perguntará ao usuário para escolher qual template usar para a descrição do PR.

Template padrão

Se nenhum template for encontrado no seu projeto, Bob usa um template integrado que inclui:

Um título descritivo derivado do nome do seu branch
Um resumo de mudanças
Detalhes de implementação principais
Informações de teste
Quaisquer links ou referências relevantes

Editando a descrição gerada

Após gerar a descrição do PR, Bob a apresenta diretamente no chat. Você pode então:

Confirmar e continuar: Aprovar a descrição como está para prosseguir com a criação do PR.
Solicitar alterações: Digitar seu feedback no chat e Bob regenerará a descrição com base nas suas indicações. Você pode iterar quantas vezes precisar antes de confirmar.

Personalizando templates

Para melhores resultados com a geração de PR do Bob:

Use títulos de seção claros nos seus templates (ex: ## Summary, ## Changes)
Inclua texto placeholder que fornece contexto (ex: )
Considere adicionar seções para instruções de teste e problemas relacionados

Dicas e melhores práticas

Use nomes de branch descritivos para ajudar Bob a gerar descrições de PR mais precisas.
Revise e edite a descrição gerada antes de criar o PR.

Pull requests