Melhores Práticas para Usar Git no Desenvolvimento de Software

André Borba
2 min readJul 22, 2024

--

O Git é uma ferramenta essencial no desenvolvimento de software moderno, proporcionando controle de versão e capacidades de colaboração. Para aproveitar ao máximo o Git, é crucial seguir algumas melhores práticas. Aqui estão as principais regras a serem lembradas ao trabalhar com o Git:

1. Trabalhe em uma Branch de Funcionalidade

Por que:

  • Isola o trabalho em uma branch dedicada, mantendo a branch principal estável.
  • Permite a submissão de múltiplos pull requests sem confusão.
  • Evita a poluição da branch master com código instável ou inacabado.

2. Ramifique a Partir de Develop

Por que:

  • Garante que o código na master compile sem problemas.
  • Mantém a branch master pronta para lançamentos.

3. Nunca Faça Push Direto nas Branches Develop ou Master. Faça um Pull Request.

Por que:

  • Notifica os membros da equipe sobre funcionalidades concluídas.
  • Permite a revisão de código pelos pares.
  • Fornece um fórum para discutir as funcionalidades propostas.

4. Atualize Sua Branch Develop Local e Faça um Rebase Interativo Antes de Fazer Push na Sua Feature e Criar um Pull Request.

Por que:

  • Mescla a branch solicitada e aplica os commits locais no topo, evitando commits de merge.
  • Mantém um histórico de commits limpo e organizado.

5. Resolva Conflitos Potenciais Durante o Rebase e Antes de Criar um Pull Request.

Por que:

  • Garante que todos os conflitos sejam resolvidos localmente, facilitando a integração do código.
  • Evita conflitos complexos na branch principal, mantendo a estabilidade do código.

6. Exclua Branches de Funcionalidade Locais e Remotas Após o Merge.

Por que:

  • Evita o acúmulo de branches obsoletas na lista de branches.
  • Garante que as branches de funcionalidades sejam mescladas apenas uma vez.

7. Certifique-se de que Sua Branch de Funcionalidade Compila com Sucesso e Passa em Todos os Testes (Incluindo Verificações de Estilo de Código) Antes de Criar um Pull Request.

Por que:

  • Evita introduzir builds falhos nas branches estáveis.
  • Garante a legibilidade do código e formatação consistente.

8. Use um Arquivo .gitignore.

Por que:

  • Exclui arquivos de sistema desnecessários e configurações do editor do repositório.
  • Evita a inclusão de pastas de dependências.

9. Proteja as Branches Develop e Master.

Por que:

Evita alterações inesperadas e irreversíveis nas branches prontas para produção.

Conclusão

Seguir essas melhores práticas ao usar Git no desenvolvimento de software é essencial para manter um fluxo de trabalho organizado e eficiente. Trabalhar em branches de funcionalidade, realizar rebases interativos, resolver conflitos localmente e proteger as branches principais são passos fundamentais para garantir a estabilidade do código e facilitar a colaboração entre os membros da equipe. Ao adotar essas práticas, você minimiza conflitos, mantém um histórico de commits limpo e assegura que o código integrado esteja sempre pronto para produção.

--

--