Olá, dev!

Este artigo apresenta o comando commit, do git, as situações em que ele é aplicado, exemplos de uso e boas práticas de uso.

Sumário

1.   Introdução

2.  O compartilhamento de arquivos pelo Git

3.  O comando commit, do Git

4.  Boas práticas de uso do comando commit

5.   Considerações finais

6.   Referências

1 – Introdução

 Nós, programadores, já estamos bem acostumados a trabalhar em projetos em equipe, que envolvem colaboração, troca remota de arquivos, edição e análise de arquivos de outras pessoas. Para que este tipo de trabalho seja eficiente, é preciso usar ferramentas adequadas. Uma destas ferramentas é o Git, outra é o Github.

O Git é um sistema distribuído de versionamento de documentos, muito usado no desenvolvimento de software, como códigos-fonte e arquivos de recursos, como imagens e outros tipos. Já o Github é uma plataforma de armazenamento de arquivos e de colaboração entre devs. 

Este artigo apresenta o comando commit, do Git, as situações em que ele é aplicado, exemplos de uso e boas práticas de uso.

2 – O compartilhamento de arquivos pelo Git

O compartilhamento de arquivos pelo Git tem as seguintes características:

·        O usuário edita arquivos no seu repositório local (pasta local);

·        O usuário cria uma cópia de um repositório, armazenado remotamente no Git;

·        Os arquivos alterados pelo usuário podem ser enviados para o repositório remoto;

·        O diretório local, rastreado pelo Git, ativado por um comando git init, por exemplo, é chamado de “Working directory”;

·        Os arquivos alterados pelo usuário e adicionados no “Working Directory” ficam em uma área chamada de “Staging area” ou “stage” (palco, em tradução livre);

Já o processo de compartilhamento de arquivos pelo Git, exige que o usuário realize os passos seguintes:

·        Preparar o ambiente para o envio de arquivos, usando:

git init– habvilita o repositório local para o envio de arquivos;

 ·        Criar arquivos no repositório local;

·        Copiar arquivos remotos, usando:

git clone – Copia (clona) arquivos do repositório remoto;

·        Atualizar a lista de arquivos que serão enviados para o repositório remoto, por meio dos comandos:

git add – adiciona arquivos na lista de arquivos ao “stage”, a enviar para o repositório remoto;

git rm – remove arquivos da lista de arquivos ao “stage”;

·        Salvar a lista de arquivos que serão enviados para o repositório remoto, por meio dos comandos:

git commit – salva a lista de arquivos do “stage”, para enviar ao repositório remoto;

·        Enviar os arquivos alterados para o repositório remoto.

git push – envia os arquivos da lista para o repositório remoto;

A figura a seguir mostra as características e o processo de atualização de arquivos no Git.

3 – O comando commit, do Git

Todas o conteúdo desta seção foi baseado na documentação oficial do comando commit, no site do Git [1].

O comando git commit, do Git, é usado para gravar as alterações feitas no repositório local do usuário, atualizando os arquivos que serão enviados parta o repositório remoto.

A sintaxe deste comando é:

Git commit <opção> <argumentos>

Onde:

·        commit – é a palavra reservada para uso do comando;

·        <opção> - opção que indica a ação que será realizada pelo comando;

·        <argumentos> - são os dados que complementam o comando (nomes de arquivos etc.)

 O uso mais comum deste comando é:

 Git commit -m <mensagem>

Onde:

·        -m: opção que indica uma mensagem, descritiva sobre este comando;

·        <mensagem>: é uma mensagem textual (“string”) que descreve o uso desta atualização.

Seguem alguns exemplos de uso do comando commit.

Exemplo 1 – informando os arquivos atualizados no repositório local

Supondo que o repositório acabou de ser inicializado e o usuário criou os arquivos index.html e estilo.css, ele poderia usar os comandos:

> git add index.html, estilo.css

> git commit -m “Primeiro commit do jogo da cobrinha”

Exemplo 2 – deixando o Git descobrir os arquivos que foram atualizados

Outra forma de realizar a mesma operação, sem precisar informar os arquivos que foram alterados é usando a opção -a, deixando para o próprio Git detectar automaticamente quais arquivos foram alterados. No exemplo abaixo, será alcançado o mesmo resultado do exemplo anterior:

> git commit -am “Primeiro commit do jogo da cobrinha”

Após executar o comando commit, o usuário pode enviar os arquivos da lista atualizada para o repositório remoto, por meio do comando git push.

4 – Boas práticas de uso do comando commit

Saeid [2] lista 10 boas práticas para uso do comando git commit, resumidas a seguir:

1.   Usar mensagens significativas, evitando mensagens ambíguas;

2.   Informar o número do problema (bug #123), criando uma conexão clara entre o commit e a tarefa ou bug associado.

3.   Comitar regularmente, confirmando quando tiver concluído uma única alteração lógica, mesmo que seja pequena;

4.   Usar commits atômicos, cada um representando apenas uma alteração específica;

5.   Dar crédito a coautores (quando necessário), em trabalhos feitos em colaboração com outros desenvolvedores;

6.   Evitar submeter arquivos gerados automaticamente, pois eles podem ser regenerados a partir de arquivos de origem, podendo usar um arquivo .gitignore para isso;

7.   Informar um link para recursos externos (no texto da mensagem do commit), no caso de mudanças influenciadas por este tipo de recurso;

8.   Usar ganchos (commit hooks) de confirmação para padrões, scripts fornecidos pelo Git que podem ser executados automaticamente antes ou depois de eventos importantes;

9.   Incluir testes nos commits, para verificar se suas alterações funcionam conforme o esperado e não quebrarão seu código;

10. Ser consistente, seguindo convenções estabelecidas, pois um histórico de commits consistentes é muito mais legível e fácil de seguir.

5 – Considerações finais

Este artigo tratou do comando commit do Git. O Git é um sistema distribuído de versionamento de documentos, muito usado por programadores, em desenvolvimento de software, para compartilhamento de arquivos em trabalho em equipe.

Primeiro, foram apresentadas as características de compartilhamento de arquivos usando o Git. Depois, foi abordado o comando commit, do Git, nos seus usos mais comuns.

Finalmente, foram listadas boas práticas de uso do Git, em trabalhos de desenvolvimento de software.

Os devs experientes já estão acostumados a usar o Git e o Github. É altamente recomendável que programadores iniciantes comecem a usar estas ferramentas desde o início do aprendizado em desenvolvimento de software

6 – Referências

A primeira referência é a documentação oficial do comando git commit, no site do Git.

[1] Git, git commit. Disponível em: <https://git-scm.com/docs/git-commit/pt_BR>. Acesso em:09/03/2024.

[2] Saeid, 10 Essential Practices for Better Git Commits and Why They Matter. Disponível em: <https://medium.com/@saeid/10-essential-practices-for-better-git-commits-and-why-they-matter-3cfc420bf53e>. Acesso em: 09/03/2024.