repositorios.md 2.0 KB

Os repositorios

Un repositorio é un espazo no que se almacena e mantén información dixital. Na forxa cada proxecto terá o seu propio repositorio.

Os repositorios poderán ter a estructura que os usuarios conveñan pero sempre haberá algúns elementos comúns, por exemplo:

O arquivo README.md

Este arquivo mostrarase de xeito automático ao acceder ao repositorio.

Contén a información básica sobre o proxecto. Existen algúns criterios estandar á hora de deseñar un arquivo README.md, debendo en xeral abordarse os seguintes aspectos:

Resumo

Ao inicio do arquivo deberemos incluir unha breve introducción que explique o que do proxecto ou repositorio. Este texto será o que despois poderemos usar para os perfís das redes sociais ou pequenas reseñas.

Exemplo de uso

No caso de que o repositorio resolva un problema, a continuación deberemos explicitar do xeito máis claro posible cal é. Este é pois o espazo para contar o como do noso proxecto. No caso de que o noso proxecto sexa un proxecto de software, aquí deberemos mostrar un fragmento do código ou un pantallazo do uso principal, tentando de ser o máis claros posible.

Motivación

Unha breve descripción da motivación tras o proxecto. Esta é pois o lugar para explicar por que o proxecto ten sentido.

Documentación

Dependendo do tamaño do proxecto, se este non é moi complexo podemos incluir directamente a documentación no arquivo README.md. Para proxectos dun tamaño maior ou cando a documentación sexa máis extensa procuraremos facilitar a referencia á documentación existente.

Contribuintes

Indícalle á xente como pode formar parte do proxecto, así como as ferramentas que hai á súa disposición para facer achegas: contas das rrss, irc, xestor de incidencias...

Licencia

Unha breve descripción da licencia que ten o proxecto (Creative Commons, MIT, Apache, GPL, etc.)