Adotar boas práticas é fundamental para ser um desenvolvedor eficaz e um bom membro de equipe.

Boas Práticas Essenciais para o Dia a Dia

• Commits Pequenos e Focados: Cada commit deve representar uma única unidade lógica de mudança. Isso facilita:
  • A revisão de código por colegas.
  • A identificação e reversão de bugs (se um bug for introduzido, você sabe exatamente qual commit o causou).
  • O entendimento do histórico do projeto.
  • Exemplo: Em vez de "Fiz login, cadastro e página inicial", faça 3 commits: "feat: Implementa fluxo de login", "feat: Adiciona tela de cadastro", "feat: Cria estrutura da página inicial".
• Mensagens de Commit Claras e Descritivas: Sempre escreva mensagens que expliquem o quê e porquê das suas mudanças. A primeira linha é um resumo conciso, e um corpo mais detalhado pode seguir (separado por uma linha em branco).
• Use Branches para Tudo: Este é um princípio fundamental. Nunca trabalhe diretamente na branch main (ou master). Crie uma nova branch para cada tarefa: uma nova funcionalidade, uma correção de bug, uma pequena refatoração, ou até mesmo um experimento.
• Sempre git pull antes de Começar a Trabalhar e Antes de Enviar (git push):
  • Ao iniciar uma tarefa: Antes de começar a codificar, execute git pull origin <sua-branch-atual> (ou git pull origin main se estiver na main) para garantir que você tem as últimas atualizações do repositório remoto. Isso minimiza a chance de conflitos futuros.
  • Antes de enviar (git push): Faça um git pull antes de cada git push. Se outra pessoa já enviou mudanças para a mesma branch, o pull as integrará localmente primeiro, evitando que seu push seja rejeitado.
• Use Pull Requests (PRs) para Colaboração: Em um ambiente de equipe, após terminar uma funcionalidade em sua branch e enviá-la para o GitHub, você cria um Pull Request (PR). Um PR é uma solicitação formal para que suas mudanças sejam revisadas por outros membros da equipe (Code Review). Após a revisão e aprovação, as mudanças são mergidas na branch principal.

Fluxo de Trabalho Git Colaborativo (Simplificado e Comum)

Este é um fluxo de trabalho básico que você aplicará em nossos projetos e encontrará em muitas equipes de desenvolvimento.

1. Sincronizar a Branch Principal (main / master): No início do dia ou antes de começar uma nova tarefa, certifique-se de que sua branch local main está atualizada com a branch main do repositório remoto (GitHub).

   git switch main           # 1. Troca para a branch principal do seu projeto
   git pull origin main      # 2. Puxa as últimas atualizações do GitHub para sua main local
   
   

2. Criar uma Nova Branch para Sua Tarefa: A partir da sua branch main que acabou de ser atualizada, crie uma nova branch específica para a funcionalidade, bugfix ou tarefa em que você vai trabalhar.

   git switch -c feature/nome-da-sua-feature-ou-bugfix
   # Exemplo: git switch -c feat/implementa-cadastro-usuario
   
   

3. Desenvolver e Comitar Regularmente: Codifique suas mudanças. À medida que você faz progresso em uma parte lógica da tarefa (por exemplo, termina uma função, implementa uma tela), adicione seus arquivos e faça commits. Lembre-se de commits pequenos e mensagens claras!

   git status                # Verifica o que mudou no seu código
   git add .                 # Adiciona os arquivos modificados/novos ao staging area
   git commit -m "feat: Mensagem descritiva do que foi feito nesta etapa"
   # Repita 'git add' e 'git commit' várias vezes enquanto trabalha na feature
   
   

4. Enviar Sua Branch para o Remoto: Envie sua branch de feature para o GitHub. Isso serve como um backup do seu trabalho e permite que outros vejam seu progresso (se for um projeto de equipe). Faça isso regularmente.

   git push -u origin feature/nome-da-sua-feature-ou-bugfix
   
   

5. Integrar suas mudanças (via Merge ou Pull Request): Quando sua funcionalidade estiver pronta, testada e você quiser integrá-la ao código principal:

   • Opção A: Merge Local (para projetos solo ou quando a equipe aprova):
     1. Volte para a main: git switch main
     2. Puxe as últimas mudanças da main remota novamente (fundamental para evitar conflitos!): git pull origin main
     3. Faça o merge da sua feature branch na main: git merge feature/nome-da-sua-feature-ou-bugfix
     4. Se houver conflitos, resolva-os, adicione e comite o resultado.
     5. Envie a main atualizada para o GitHub: git push origin main
   • Opção B: Criar Pull Request (Mais Comum em Equipes):
     1. Envie sua feature branch para o GitHub (se já não o fez).
     2. Vá para o GitHub e crie um Pull Request (PR) da sua feature/nome-da-sua-feature-ou-bugfix para a main.
     3. Preencha a descrição do PR (o que ele faz, por que, como testar).
     4. Peça por uma revisão de código (Code Review).
     5. Após a aprovação e resolução de quaisquer comentários, o PR é mergido na main (geralmente por um revisor ou você mesmo, dependendo da configuração).
     6. Depois que o PR for mergido no GitHub, você precisa atualizar sua main localmente: git switch main e git pull origin main.

6. Deletar a Branch (Opcional): Após o merge da sua branch de feature na main (e o push da main atualizada), a branch de feature geralmente não é mais necessária. Você pode deletá-la para manter seu repositório limpo.

   • Deletar localmente (só se ela já foi mergida com segurança):

     git branch -d feature/nome-da-sua-feature-ou-bugfix
     
     

   • Deletar remotamente (no GitHub):

     git push origin --delete feature/nome-da-sua-feature-ou-bugfix
     
     

Exercícios Práticos do Módulo 1

• Projeto Base: Tech Connect Hub
  • Tarefa 1: Criação e Clone do Repositório Privado e Configuração Inicial
    • Criação do repositório tech-connect-hub (privado, sem README/gitignore iniciais) no GitHub.
    • Criação da pasta local tech-connect-hub e git init.
    • Criação local de .gitignore (gerado via gitignore.io para Python/Django) e README.md (com estrutura inicial e descrição do projeto).
    • Primeiro commit local (git add ., git commit -m "feat: Setup inicial do projeto com .gitignore e README").
    • Conexão ao GitHub e primeiro push (git remote add origin <URL>, git push -u origin master).
  • Tarefa 2: Criação da Estrutura Básica do Projeto Django
    • Criação da branch feat/initial-django-setup.
    • Criação e ativação do ambiente virtual (python -m venv .venv).
    • Instalação do Django (pip install Django).
    • Início do projeto Django (django-admin startproject setup .).
    • Commit e push dessa branch (git add ., git commit -m "feat: Cria estrutura inicial do projeto Django", git push -u origin feat/initial-django-setup).