Boas Práticas de Git e GitHub para Desenvolvedores

Git e GitHub são ferramentas indispensáveis no desenvolvimento de software moderno, permitindo um controle de versão eficiente e uma colaboração em equipe sem atritos. Neste artigo, exploraremos algumas boas práticas essenciais para aproveitar ao máximo o Git e o GitHub em seus projetos.

Mantenha Commits Pequenos e Atômicos

Uma boa prática de Git é manter commits pequenos e atômicos. Cada commit deve representar uma única alteração ou conjunto de alterações relacionadas. Isso facilita a revisão de código e o entendimento das mudanças ao longo do tempo. Aqui está um exemplo de como isso pode ser feito:

git add .
git commit -m "Adicionar funcionalidade de login"

Escreva Mensagens de Commit Descritivas Escrever mensagens de commit claras e descritivas é fundamental para um bom controle de versão. As mensagens de commit devem explicar o que foi alterado e por quê. Use um formato consistente, como o Conventional Commits, para padronizar suas mensagens de commit. Veja um exemplo:

git commit -m "fix: Corrigir erro de digitação no título"

Utilize Branches Adequadamente

O uso correto de branches é essencial para um fluxo de trabalho organizado. Use branches para desenvolver novos recursos ou corrigir bugs sem afetar o código principal. Mantenha uma estratégia de branch limpa, como Gitflow ou GitHub Flow, para garantir um fluxo de trabalho colaborativo e eficiente. Faça Pull Requests para Revisão de Código Antes de mesclar suas alterações no branch principal, envie um pull request para revisão de código. Isso permite que outros membros da equipe revisem suas alterações, ofereçam feedback e garantam a qualidade do código. Veja como criar um pull request:

  1. Faça o push das suas alterações para o GitHub:
git push origin minha-branch
  1. Vá para a página do seu repositório no GitHub e clique em "Compare & pull request".
  2. Preencha as informações necessárias e clique em "Create pull request".

Exemplo de informações úteis para o Pull Request

# PR - "NOME DO PROJETO"

## Link do Ticket da TAREFA :

## Descreva as mudanças realizadas :

## Testes Realizados

### Dispositivos Mobile

- [ ] Android
- [ ] iPhone (iOS)
 
### Navegadores no Desktop

- [ ] Chrome
- [ ] Safari
- [ ] Opera
- [ ] Firefox
- [ ] Edge / IE

## Outros Links _(opcional)_ : 

## Imagens _(opcional)_ :

Automatize Testes e Integração Contínua

Configure pipelines de integração contínua para automatizar testes e análises de código. Isso ajuda a identificar problemas rapidamente e garante que apenas alterações de qualidade sejam mescladas no código principal. Aqui está um exemplo de configuração de um pipeline de CI usando GitHub Actions:

name: CI

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Install dependencies
      run: npm install

    - name: Run tests
      run: npm test

Utilize Git Tags para Versionamento

Use tags do Git para marcar versões estáveis do seu software. Isso facilita o rastreamento e a implantação de versões específicas e fornece um histórico claro das versões lançadas. Veja como criar e listar tags:

git tag -a v1.0.0 -m "Versão 1.0.0"
git push --tags
git tag

Conclusão

Seguir boas práticas de Git e GitHub é fundamental para um desenvolvimento de software eficiente e colaborativo. Ao adotar essas práticas em seus projetos, você garantirá um fluxo de trabalho mais suave, maior qualidade de código e uma experiência de desenvolvimento mais agradável para toda a equipe.