Ao gerar um novo Repositório Git uma estrutura básica é criada com os arquivos necessários para o funcionamento correto do Git. Nesse artigo irei abordar quais são esses arquivos e qual a função de cada um deles.

Esse é apenas um de uma lista de artigos introdutórios ao Git. Segue abaixo o link para o artigo anterior:

Introdução ao Git: Conceitos básicos

Os mesmos conceitos de pastas e arquivos dos computadores podem ser aplicados aos Repositórios Git. Dessa forma, ao trazer os arquivos e pastas do Repositório Remoto para o Repositório Local, eles podem ser acessados normalmente pelo gerenciador de arquivos do sistema operacional. Do lado oposto, sempre que for feito o envio de novos arquivos do Repositório Local para o Repositório Remoto todas as pastas inexistentes serão criadas para comportar seus respectivos arquivos.

Tendo isso em mente, quando um novo Repositório é gerado os seguintes arquivos e pastas podem ser criados:

.git (Pasta)

A pasta oculta “.git” contém os arquivos de configuração do Repositório Git. É nela que ficam armazenadas informações como: a identificação do Repositório Remoto, o histórico dos Commits locais, a identificação de qual Branch está sendo utilizada atualmente, etc. Por conter as informações necessárias para o funcionamento do Git, por segurança, não é recomendado alterar o conteúdo dessa pasta.

.gitignore (Arquivo)

O arquivo oculto “.gitignore” contém a listagem de arquivos e pastas que não devem ser versionadas pelo Git. Arquivos de configuração de ambiente, por exemplo, não devem ser versionados pois cada desenvolvedor tem um ambiente único, logo, os arquivos de configuração de ambiente são diferentes. Ao listar esses arquivos e pastas no “.gitignore” eles serão ignorados pelo Git no Commit.

.gitkeep (Arquivo)

O arquivo oculto “.gitkeep” é gerado apenas para criar uma pasta vazia no Repositório Remoto. As pastas não são enviadas pelo Git para o Repositório Remoto caso estejam vazias e são removidas junto a seu conteúdo caso ele seja excluído. Para contornar isso, é possível criar um arquivo chamado “.gitkeep” na pasta em questão para que a mesma seja mantida no Repositório Remoto mesmo sem conter arquivos.

README.md (Arquivo)

O arquivo “README.md” é a porta de entrada para o Repositório. Quando a página web do Repositório no servidor Git é acessada, o conteúdo do “README.md” é apresentado em destaque. Nele, geralmente, são apresentadas as informações do Repositório como: a descrição do projeto, a forma de utilização do código, uma menção aos integrantes do projeto, etc.

LICENCE.md (Arquivo)

O arquivo “LICENCE.md” contém as informações de licença do Repositório. A licença define quais são os usos permitidos do código presente no repositório.

Caso tenha ficado em dúvida sobre o ponto (.) ou a extenção md (.md) no nome de pastas e arquivos, segue a explicação:

  • O ponto no inicio do nome de pastas e arquivos é utilizado para oculta-los nos sistemas baseados em UNIX (Mac OS e Linux). O Windows não oculta nativamente as pastas e arquivos iniciados com um ponto.
  • A extensão md é utilizada em arquivos do tipo Markdown. Markdown é uma linguagem de marcação que, em modo visualização, transforma o texto em um HTML válido.

Dicas de Conteúdo:

Se gostou do artigo e tem interesse de se aprofundar mais no assunto seguem abaixo algumas dicas de conteúdo de qualidade:

Git: Guia Prático (Livro)

Introdução ao GitHub: um Guia que Não é Técnico (Livro)

Outras opções de livros