Pro Git
Pro Git Hay dos archivos especiales que GitHub detecta y maneja si están presentes en el repositorio.
En primer lugar tenemos el archivo README, que puede estar en varios formatos. Puede estar con el nombre README, README.md, README.asciidoc y alguno más. Cuando GitHub detecta su presencia en el proyecto, lo muestra en la página principal, con el renderizado que corresponda a su formato.
En muchos casos este archivo se usa para mostrar información relevante a cualquiera que sea nuevo en el proyecto o repositorio. Esto incluye normalmente cosas como:
Para qué es el proyecto Cómo se configura y se instala Ejemplo de uso Licencia del código del proyecto Cómo participar en su desarrolloPuesto que GitHub hace un renderizado del archivo, puedes incluir imágenes o enlaces en él para facilitar su comprensión.
El otro archivo que GitHub reconoce es CONTRIBUTING. Si tienes un archivo con ese nombre y cualquier extensión, GitHub mostrará algo como Apertura de un Pull Request cuando existe el archivo CONTRIBUTING. cuando se intente abrir un Pull Request.
