GitHub, preparación del repositorio

Ya tenemos un nuevo repositorio para nuestro proyecto. Ya sea público o privado, lo mejor es tener documentación clara sobre nuestro proyecto. Hay una serie de archivos predefinidos que permiten conocer el objeto y destino de nuestro código.

El primero de los archivos es el README con el que se comunica información importante sobre el proyecto.

Creamos un README.md que debería dar la siguiente información de forma clara y concisa

- Qué es lo que hace el proyecto
- Cuál es la utilidad del proyecto
- Cómo un usuario puede ponerlo en marcha
- Dónde se puede obtener ayuda sobre el proyecto
- Quién mantiene y contribuye al proyecto

Si agregas un archivo de README a la raíz de un repositorio público con el mismo nombre que tu nombre de usuario, dicho README aparecerá automáticamente en tu página de perfil. Puedes editar el README de tu perfil con el Marcado Enriquecido de GitHub para crear una sección personalizada en tu perfil.

El siguiente archivo es el LICENSE, en el que se indica a qué licencia se atiene el contenido que has publicado en el repositorio. El archivo es LICENSE.md. la licnecia de tipo Open Source hace que se amás fàácil que otros puedan contribuir al proyecto.

para crear un archivo de licencia, GitHub lo facilita con estos pasos:

- En GitHub.com, navegue a la página principal del repositorio
- Sobre la lista de archivos, usando el menú desplegable Agregar archivo, haga clic en Crear nuevo archivo. "Crear nuevo archivo" en el menú desplegable "Agregar archivo"
- En el campo de nombre de archivo, escriba LICENCIA o LICENCIA.md (en mayúsculas)
- A la derecha del campo de nombre de archivo, haga clic en Elegir una plantilla de licencia. Elija un botón de plantilla de licencia
- En el lado izquierdo de la página, en "Agregar una licencia a su proyecto", revise las licencias disponibles y luego seleccione una licencia de la lista. Lista de licencias disponibles
- Clica en Revisar y Enviar

Finalmente creamos un .gitignore, con el punto inicial para indicar que es un archivo oculto. En el .gitignore se listan los archivos que no queremos que pasen al repositorio, o que son solo de lectura.

Podemos utilizar estos símbolos para referenciar los archivos y carpetas a ignorar:

* se utiliza como una coincidencia comodín.
/ se usa para ignorar las rutas relativas al archivo .gitignore.
# es usado para agregar comentarios

Ejemplos de reglas en un archivo .gitignore