Notas personales del proyecto

En ocasiones podemos disponer de una buena documentación, una wiki del proyecto o cualquier plataforma de colaboración que nos permita consultar y compartir información técnica, configuraciones, procesos de gestión… Pero seamos sinceros, documentar no es lo que más nos gusta a los ingenieros de desarrollo de software y estas opciones no siempre están disponibles para nosotros. Por otro lado, es posible que quieras disponer de algunas notas personales, scripts de automatización o incluso configuraciones personales para el proyecto donde estás colaborando.

Para poder disponer de un lugar donde guardar este tipo de información tengo el hábito de crear en la carpeta principal del proyecto, siempre que esté versionado con git, una carpeta para mis notas personales del proyecto. Es cierto que podría disponer de esta información en cualquier otro lugar de mi equipo, pero ubicándola en el propio proyecto consigo mayor orden y facilidad de acceso a mis pequeños tesoros. Ahora bien ¿Cómo se me ocurre añadir al proyecto una carpeta de caracter personal y que incluso podría contener información sensible? Esto es lo mejor, gracias a git puedo usar dicha ubicación, ordenada y accesible, sin enturbiar el proyecto. Te explico a continuación como lo hago.

En mis carpetas personales de configuración, mis dotFiles, dispongo de un archivo de configuración de .gitignore_global que contiene la siguiente línea:

# Ignore my personal project notes
personal-project-notes/

Ahora se trata de configurar git, a nivel global, para que use dicho archivo de configuración. Si no usaste .gitignore_global para nombrar tu archivo no olvides modificarlo en el siguiente script.

git config --global core.excludesfile ~/documents/dotFiles/.gitignore_global

¡Y listo, ya puedes crear en la carpeta raiz tu propia carpeta personal-project-notes sin molestar al resto de colaboradores!

Si en algún momento quieres consultar la ubicación del archivo que estas usando en la configuración global de git para ignorar carpetas o archivos puedes ejecutar el siguiente comando:

git config --get core.excludesfile