Boas práticas

Revise antes de commitar

Sempre revise suas alterações antes de commitá-las, para garantir a qualidade do código e evitar erros.

Use git diff e git status para revisar as alterações dentro e fora do stage antes de commitar. Isso ajuda a pegar erros, instruções de depuração e alterações acidentais.

Ruim

git add .
# Alterações acidentais adicionadas
# às cegas ao próximo commit.
git commit -m "Fixed login bug"
git push

Commitar sem revisar as alterações.

Bom

git add .
# Revise as alterações antes de commitar.
git diff --staged
git commit -m "Fixed login bug"
git push

# Adicione ao stage só o arquivo desejado.
git add src/login.js
# Mesmo assim, revise antes de commitar.
git diff --staged
git commit -m "Fixed login bug"
git push

Revise as alterações antes do commit para evitar que alterações acidentais subam para o repositório.

O que costuma passar despercebido sem uma revisão

Restos de depuração, como instruções console.log, variáveis/funções temporárias, etc.

Código comentado, TODOs concluídos.

Alterações sem relação com o próximo commit. Acontece muito quando você trabalha em várias features ao mesmo tempo.

Chaves de API temporárias ou outros segredos que não deveriam estar no repositório. O melhor é adicioná-los ao .gitignore.

Problemas gerais de qualidade do código, como erros de sintaxe, erros de digitação ou problemas de formatação. Olhar o código antes de commitar ajuda a pegá-los, porque, ao revisar o diff, você consegue focar nas alterações feitas em vez do arquivo inteiro.

Comandos úteis para revisão

Veja quais arquivos mudaram:

git status

Revise as alterações fora do stage:

git diff

Revise as alterações no stage:

git diff --staged

Revise as alterações de um arquivo específico:

git diff src/auth.js

Mostre alterações detalhadas com contexto:

git diff --word-diff

Revisão em um editor baseado no VS Code

Se você usa o VS Code, o Cursor, o Antigravity IDE ou outro editor baseado no VS Code, revisar alterações ainda não commitadas na interface gráfica é simples. Abra o painel Source Control e você verá os arquivos alterados no seu diretório de trabalho.

Ops, esqueci de remover um comentário TODO da alteração que fiz.

Git

ByBit

Começar o curso