Skip to content

Commit

Permalink
WIP: Create post about git commits
Browse files Browse the repository at this point in the history
  • Loading branch information
ruan-brandao committed Jan 9, 2020
1 parent a6afef9 commit 8c54af7
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions _posts/2020-01-20-como-fazer-um-bom-commit.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
layout: post
title: "Como fazer um bom commit no Git"
date: 2020-01-20 19:00:00
tags: Git
image: black-panther-unsplash.jpg
image-description: Porta-revistas preto em um fundo de madeira marrom contendo três revistas, duas delas cor-de-laranja com o título Black Panther e uma azul com o título Shuri
image-author: Alicia Quan
image-author-link: https://unsplash.com/@alicia2joy?utm_medium=referral&utm_campaign=photographer-credit&utm_content=creditBadge
comments: true
---



# Introdução, como git é útil e como é uma boa ferramenta de documentação

Git é uma ferramenta muito importante para se desenvolver software de qualidade hoje em dia. Ela permite

Git é uma importante ferramenta de **documentação**. O histórico de commits de um projeto é um ótimo lugar para acompanhar como o código e o software em si evoluíram ao longo do tempo. Ter isso a disposição é bastante útil em diversos casos.

Porém, para que isso aconteça, é preciso que o projeto possua bons commits. Isso vai facilitar a compreensão das mudanças que ocorreram no software ao longo do tempo e dar mais segurança para que o projeto continue evoluindo em uma boa velocidade.



# O que é um commit e pra que ele serve

Git é uma ferramenta de controle de versão. Ou seja, é uma ferramenta que serve para controlar um projeto de software e as mudanças que ocorrem neste projeto ao longo do tempo, e o commit é a peça básica (fundamental) para isso.

Um commit serve como um **ponto de retorno** no projeto. O Git possibilita acessar o código exatamente como ele estava no momento que o commit aconteceu.
Isso é bastante útil para diferentes casos:
- Dar segurança para fazer alterações. Tendo um commit do projeto funcionando, posso mexer no código e fazer minhas alterações com mais segurança, pois se eu escrever um código que não funciona ou que quebre alguma funcionalidade, posso voltar para o último commit com as coisas funcionando.
- Ao investigar um bug, é possível executar o projeto em algum commit do passado, antes do bug ser introduzido no projeto. Isso pode ajudar a isolar onde o bug está e quando ele foi introduzido na base de código.

Imagine que você tem que fazer aquele trabalho de escola, curso ou faculdade bem longo, aquele que tem páginas e páginas de conteúdo. Aí você resolve fazer uma versão inicial do trabalho em documento chamado `Trabalho.docx`.
No dia seguinte você vê o link de uma matéria muito interessante que tem tudo a ver com o tema do trabalho e decide colocar esse conteúdo adicional no trabalho e decide salvar essa versão nova em um arquivo separado chamado `Trabalho-2.docx`. Assim você ainda consegue acessar a versão original do trabalho caso precise. Com o passar do tempo você vai fazendo alterações no trabalho, sempre criando novos arquivos. Assim v

O commit é isso. Um ponto salvo de como é o estado do projeto neste momento, de modo que o conjunto dos commits em um projeto mostra a evolução do mesmo ao longo do tempo. Sendo assim, caso seja necessário ver como estava o código do projeto um ano atrás, é possível voltar para um commit de um ano atrás e acessar o projeto inteiro como ele estava naquele momento.

Isso mostra como Git é uma ferramenta importantíssima de **documentação** em um projeto de software. Precisa ver quando uma funcionalidade foi incluída no projeto, ou quando foi realizada a migração de uma biblioteca externa para uma biblioteca própria? O histórico de commits do projeto está lá para ajudar.

No entanto, para que o Git consiga cumprir esta função, é necessário que um commit comunique efetivamente como as mudanças no projeto ocorreram ao longo do tempo.

### Mensagem do commit



### Quanto código deve ir em um commit








# Dicas extras, padrões e melhores práticas para commits -> https://afterhours.io/git-field-guide.html

0 comments on commit 8c54af7

Please sign in to comment.