O que é um arquivo .gitignore?

Um arquivo .gitignore informa ao Git quais arquivos devem ficar fora do controle de versão: dependências que você pode instalar novamente (como node_modules), arquivos gerados pela compilação, registros, caches, configurações do editor e arquivos deixados pelo sistema operacional, como .DS_Store no macOS ou Thumbs.db no Windows. Coloque-o na pasta raiz do seu repositório. Os padrões se aplicam a essa pasta e a todas as pastas dentro dela.

De onde vêm os modelos

Os modelos fazem parte da coleção oficial do GitHub, o repositório github/gitignore; são os mesmos que o GitHub oferece quando você cria um repositório. A ferramenta carrega uma cópia atualizada diariamente. Eles estão divididos em três grupos:

  • Modelos principais para linguagens, frameworks e ferramentas, como Node, Python, Java, Go, Rust, Unity e WordPress.
  • Modelos globais para editores, sistemas operacionais e outras ferramentas, como macOS, Windows, Linux, VisualStudioCode, JetBrains e Vim. Eles servem tanto para o arquivo .gitignore de um projeto quanto para o arquivo global que o Git pode aplicar a todos os seus repositórios.
  • Modelos da comunidade para frameworks e ferramentas mais específicos, mantidos pela comunidade, como JavaScript/Vue ou Python/JupyterNotebooks.

Como usar

  1. Comece escolhendo rapidamente um tipo de projeto popular. A ferramenta seleciona os modelos da pilha de tecnologias, além dos modelos para macOS, Windows e o editor geralmente usado com ela.
  2. Ou pesquise no campo Modelos e selecione cada linguagem, framework, editor e sistema operacional usados pelo seu projeto. Desmarque um modelo ou pressione Backspace no campo para removê-lo.
  3. O arquivo .gitignore é criado à medida que você seleciona os modelos, cada um sob seu próprio comentário de cabeçalho e na ordem em que foi escolhido.
  4. Copie o arquivo ou baixe-o e salve-o na pasta raiz do seu repositório com o nome .gitignore. Os navegadores não salvam arquivos cujo nome começa com ponto, então o arquivo baixado recebe o nome gitignore.txt ou gitignore: renomeie-o para .gitignore.

Dicas

  • Dois modelos podem compartilhar um padrão, como node_modules/ nos modelos Node e Nextjs. A repetição de um padrão não causa problemas.
  • Um padrão não deixa de rastrear um arquivo que o Git já rastreia. Para parar de rastreá-lo sem removê-lo do disco, execute git rm --cached seguido do caminho do arquivo e, em seguida, faça o commit.
  • Uma linha que começa com ! restaura arquivos ignorados por um padrão anterior. O modelo VisualStudioCode usa esse recurso para manter configurações compartilhadas, como .vscode/settings.json, no repositório.

Recursos

  • Modelos .gitignore oficiais do GitHub, atualizados diariamente
  • Linguagens, frameworks, editores e sistemas operacionais em uma única lista pesquisável
  • Seleções rápidas para tipos de projeto populares
  • Cada modelo sob seu próprio cabeçalho
  • Copie ou baixe o arquivo