¿Qué es un archivo .gitignore?

Un archivo .gitignore le indica a Git qué archivos debe excluir del control de versiones: dependencias que puedes volver a instalar (como node_modules), archivos generados durante la compilación, registros, cachés, ajustes del editor y archivos que deja tu sistema operativo, como .DS_Store en macOS o Thumbs.db en Windows. Colócalo en la carpeta raíz de tu repositorio. Sus patrones se aplican a esa carpeta y a todas las que contiene.

De dónde vienen las plantillas

Las plantillas son la colección oficial de GitHub, el repositorio github/gitignore; son las mismas que GitHub ofrece al crear un repositorio. La herramienta carga una copia que se actualiza a diario. Se dividen en tres grupos:

  • Plantillas principales para lenguajes, marcos de trabajo y herramientas, como Node, Python, Java, Go, Rust, Unity y WordPress.
  • Plantillas globales para editores, sistemas operativos y otras herramientas, como macOS, Windows, Linux, VisualStudioCode, JetBrains y Vim. Son adecuadas tanto para el archivo .gitignore de un proyecto como para el global que Git puede aplicar a todos tus repositorios.
  • Plantillas de la comunidad para marcos de trabajo y herramientas más especializados, mantenidas por la comunidad, como JavaScript/Vue o Python/JupyterNotebooks.

Cómo usarlo

  1. Empieza con una selección rápida para un tipo de proyecto popular. Esta selecciona las plantillas de la pila tecnológica, además de macOS, Windows y el editor que se suele usar con ella.
  2. O busca en el campo Plantillas y selecciona cada lenguaje, marco de trabajo, editor y sistema operativo que use tu proyecto. Desmarca una plantilla o pulsa Retroceso en el campo para quitarla.
  3. El archivo .gitignore se genera a medida que haces tus selecciones, con cada plantilla bajo su propio comentario de encabezado y en el orden en que las seleccionaste.
  4. Cópialo o descárgalo y guárdalo en la carpeta raíz de tu repositorio como .gitignore. Los navegadores no guardan archivos cuyo nombre empieza con un punto, así que la descarga se guardará como gitignore.txt o gitignore; cámbiale el nombre a .gitignore.

Consejos

  • Dos plantillas pueden compartir un patrón, como node_modules/ en Node y Nextjs. Repetir un patrón no causa ningún problema.
  • Un patrón no deja de hacer seguimiento a un archivo que Git ya tiene bajo seguimiento. Para dejar de hacerle seguimiento y conservarlo en el disco, ejecuta git rm --cached seguido de la ruta del archivo y, luego, confirma los cambios.
  • Las líneas que empiezan con ! vuelven a incluir archivos que un patrón anterior había excluido. La plantilla VisualStudioCode lo usa para conservar en el repositorio ajustes compartidos, como .vscode/settings.json.

Funciones

  • Plantillas .gitignore oficiales de GitHub, actualizadas a diario
  • Lenguajes, marcos de trabajo, editores y sistemas operativos en una sola lista con búsqueda
  • Selecciones rápidas para tipos de proyectos populares
  • Cada plantilla bajo su propio encabezado
  • Copia o descarga el archivo