Manter mensagens de commit e descrições de Pull Request (PR) bem documentadas e padronizadas é fundamental para a manutenção de repositórios saudáveis, mas redigir esses textos a cada troca de contexto consome energia valiosa do desenvolvedor. O JetBrains AI Assistant é integrado nativamente às janelas de ferramentas de controle de versão dos IDEs da JetBrains (como IntelliJ IDEA, PyCharm, WebStorm e GoLand), permitindo sintetizar diffs de código em mensagens de commit precisas, executar autorrevisões com IA antes do commit e gerar descrições completas de PRs sem precisar sair do editor.
Este guia prático explica como configurar e utilizar o JetBrains AI Assistant nos fluxos de trabalho de Git, personalizar prompts de acordo com as convenções da equipe e aproveitar recursos complementares como resolução inteligente de conflitos e suporte à revisão de código.
Pré-requisitos e Configuração Inicial
Antes de gerar mensagens de commit e resumos de PR com IA, certifique-se de que seu ambiente preencha os seguintes requisitos:
- IDE JetBrains Compatível: Versão 2024.1 ou superior (como IntelliJ IDEA, PyCharm, WebStorm, GoLand, Rider ou CLion).
- Plugin AI Assistant e Assinatura Ativa:
- O plugin JetBrains AI Assistant deve estar habilitado em Settings | Plugins (
Ctrl+Alt+Sno Windows/Linux,Cmd+,no macOS). - Você deve estar conectado à sua JetBrains Account com cota ativa (teste AI Free, assinatura individual AI Pro, AI Ultimate ou licença corporativa via JetBrains Central).
- O plugin JetBrains AI Assistant deve estar habilitado em Settings | Plugins (
- Controle de Versão Configurado:
- Repositório local inicializado com Git ou Mercurial.
- Plugins integrados de Git e GitHub (ou GitLab) ativos para possibilitar o uso da janela de ferramentas de Pull Requests.
1. Gerando Mensagens de Commit com o AI Assistant
O JetBrains AI Assistant examina as modificações no staging ou nas listas de alterações selecionadas (changelists) para resumir o propósito e os impactos das alterações diretamente no formato adequado.
Passo a Passo
- Abrir a Janela de Ferramentas Commit:
- Pressione
Alt+0no Windows/Linux ouCmd+0no macOS (ou utilizeCtrl+K/Cmd+K).
- Pressione
- Selecionar as Alterações Desejadas:
- Marque as caixas de seleção correspondentes aos arquivos, blocos de código específicos ou changelists que entrarão neste commit. O assistente analisará estritamente os diffs marcados, facilitando commits parciais atômicos.
- Disparar a Geração por IA:
- Clique no ícone Generate Commit Message with AI Assistant (o símbolo de varinha mágica/brilho de IA) situado acima da caixa de mensagem de commit.
- Revisar e Concluir:
- O assistente preencherá um cabeçalho resumido acompanhado de marcadores com os principais detalhes técnicos.
- Adicione referências a tickets de tarefas (como
PROJ-1024) ou avisos de quebra de compatibilidade e confirme o commit (Ctrl+EnterouCmd+Enter).
Add JWT authentication middleware and token expiration check
- Introduce AuthTokenValidator class to verify bearer tokens
- Register authentication interceptor in security configuration
- Add unit test coverage for expired and malformed tokens
2. Personalizando Padrões de Commit e Modelos de Prompt
Muitas equipes seguem diretrizes rígidas, como Conventional Commits (feat:, fix:, refactor:), limites de caracteres ou inclusão do nome do branch. O JetBrains oferece duas formas de customização:
Método A: Configuração Direta na Janela de Commit
- Clique no ícone de engrenagem (Settings) no canto inferior direito da janela Commit.
- Na seção AI Assistant, insira as diretrizes desejadas no campo Prompt for generation.
- Use a variável embutida
$GIT_BRANCH_NAMEpara incluir dinamicamente dados do branch no prompt (exemplo:Extraia o número do ticket contido em $GIT_BRANCH_NAME e coloque-o como prefixo do commit).
Método B: Regras Globais na Prompt Library
- Abra Settings | Tools | AI Assistant | Prompt Library (
Ctrl+Alt+SouCmd+,). - Na seção Built-In Actions, selecione Commit Message Generation.
- No editor à direita, defina as regras desejadas:
- Convenção de escrita: "Adote rigorosamente o padrão Conventional Commits com prefixos como feat, fix e refactor".
- Limitação de tamanho: "Mantenha o título com no máximo 50 caracteres e quebre as linhas de descrição em até 72 caracteres".
- Idioma de saída: Configure para gerar o texto em português ou inglês conforme a preferência da equipe.
- Clique em Apply. Todas as gerações futuras respeitarão esse modelo.
3. Autorrevisão Pré-Commit com IA (Self-Review with AI)
Para evitar o envio involuntário de linhas de depuração esquecidas, chaves de API ou erros de lógica básicos, o AI Assistant oferece uma autorrevisão rápida antes da conclusão do commit:
- Na janela Commit, selecione os arquivos ou alterações que pretende enviar.
- Clique no botão Self-Review with AI.
- A janela de ferramentas Problems será aberta na aba AI Self-Review, destacando pontos de atenção:
- Trechos de depuração esquecidos (como
console.logouprint). - Riscos de ponteiro nulo, falta de tratamento de exceções e possíveis vazamentos de recursos.
- Discrepâncias de estilo de código e convenções de nomenclatura.
- Trechos de depuração esquecidos (como
- Dê um duplo clique na ocorrência ou pressione
F4para navegar ao código-fonte e aplicar as correções rápidas (Quick Fixes) sugeridas pela IDE. - Equipes podem vincular um guia interno em formato Markdown em Settings | Tools | AI Assistant | Project Settings no campo Path to rules for AI Self-Review.
4. Editando e Aprimorando Commits Já Realizados
Caso você já tenha feito um commit local, mas ainda não realizou o push para o repositório remoto, é possível usar o assistente para reescrever a descrição:
- Abra a janela de histórico do Git pressionando
Alt+9no Windows/Linux ouCmd+9no macOS. - Na lista de commits, clique com o botão direito sobre o commit desejado e escolha Edit Commit Message.
- No diálogo exibido, clique em Improve Commit Message with AI Assistant.
- A IA reanalisará os diffs daquele commit específico e fornecerá um texto mais claro. Clique em OK para salvar e faça o push (
Ctrl+Shift+KouCmd+Shift+K).
5. Gerando Títulos e Descrições de Pull Request
Ao transitar do trabalho local para a fase de revisão por pares (code review), elaborar descrições completas para Pull Requests (PR) ou Merge Requests (MR) acelera a aprovação do time.
Criação de PR Diretamente no IDE
- Abrir a Janela de Pull Requests:
- No menu principal, acerte em Git | GitHub | View Pull Requests (ou GitLab | View Merge Requests).
- Iniciar uma Nova Solicitação:
- Clique no ícone
+para abrir um novo PR/MR, definindo os branches de base e de origem.
- Clique no ícone
- Gerar Título e Corpo com um Clique:
- No editor de descrição, clique em Generate a Title and Description with AI Assistant.
- O assistente analisará todos os commits e arquivos modificados no branch, gerando uma estrutura organizada em Markdown:
- Resumo (Summary): Visão geral da funcionalidade ou do bug solucionado.
- Principais Modificações (Key Changes): Relação dos módulos alterados e novas rotinas.
- Verificação (Verification): Testes executados e passos recomendados para validação.
- Ajustar e Publicar:
- Inclua links para tarefas externas, adicione revisores e clique em Create Pull Request.
Resumo Automático de PRs de Colegas
Ao analisar solicitações de pull enviadas por outros membros da equipe, o AI Assistant também pode resumir o contexto:
- Habilite em Settings | Tools | AI Assistant | Features a opção GitHub Plugin: Generate a summary upon opening a Pull Request.
- Ao abrir o PR recebido, você terá um resumo instantâneo, podendo configurar o tom e a profundidade (Verbosity) nas preferências.
Recomendações e Melhores Práticas
| Prática Recomendada | Justificativa e Impacto |
|---|---|
| Priorizar commits atômicos (Partial Commit) | Use a seleção de linhas da IDE; diffs focados produzem mensagens objetivas e livres de generalizações vagas. |
| Validar códigos de tarefas externas | A IA analisa o código com precisão, mas não adivinha identificadores de sprint boards (como Jira); combine com $GIT_BRANCH_NAME ou ajuste manualmente. |
| Aliar às verificações nativas da IDE | Mantenha ativas as checagens pré-commit (Reformat code, Optimize imports, Analyze code) para garantir alta qualidade antes do envio. |
| Usar Merge with AI na resolução de conflitos | Ao realizar rebase ou merge com sobreposição de alterações, use o botão Merge with AI no diálogo Merge Revisions para agilizar a integração. |
Adotar o JetBrains AI Assistant na rotina diária de versionamento poupa tempo mental precioso e assegura um histórico de commits e revisões consistente, profissional e facilmente auditável por toda a organização.
Referências
- AI in version control | AI Assistant Documentation
- Create and Understand Commit Messages with AI Assistant - JetBrains Guide
- Commit and push changes to Git repository | IntelliJ IDEA Documentation
- Review incoming GitHub pull requests | IntelliJ IDEA Documentation
- AI Assistant in JetBrains IDEs - The JetBrains Blog