Mejora tus repositorios añadiendo insignias

por:

Mejora tus repositorios  añadiendo insignias

Si eres usuario habitual de GitHub, te habrás dado cuenta de que los repositorios cada día son más importantes. Además, los mismos se están convirtiendo en un punto de encuentro para los desarrolladores, donde se acumula multitud de información. Una forma de expresar esa información son las clásicas insignias que hoy te enseño a utilizar.

Metadatos de insteres en tus repositorios

Además del código, hay muchos datos sobre el repositorio que pueden ser de mucha importancia para tus usuarios, como por ejemplo:

  • La licencia.
  • El número de: commits, colaboradores, releases
  • Si los test han pasado correctamente.
  • Las versiones que se están utilizando del lenguaje, plugins, etc.

Toda esta información, permite no solo conocer cómo se realizan cada una de las funciones y la arquitectura del desarrollo, sino que también transmite cómo se trabaja en ese repositorio.

El repositorio de SendGrid muestra algunas insignias de interés.

En la imagen superior podéis ver uno de los repositorio de SendGrid, con un conjunto de insignias que indican lo siguiente:

  • El código ha pasado todos los test.
  • Está disponible en NuGet en la versión V9.9.0
  • Hay 43 suscriptores para ser informados del lanzamiento de nuevas relaseses
  • La licencia utilizada es la MIT
  • Su cuenta de Twitter cuenta con 20.000 seguidores
  • En el repositorio han contribuido 53 usuarios.

¿Cómo obtener insignias para tus repositorios?

Seguramente te estarás preguntando, lo mismo que me pregunté yo hace unos días, ¿cómo funcionan estas insignias?. Ya que parte de la gracia de las mismas, es que no son imágenes estáticas sino que se generan con los datos de cada repositorio.

Una de las web que permite conseguir estas insignas es Shields.io, y su funcionamiento es sencillo:

  1. Identificar en qué repositorio queremos usarlo, en mi caso ganchito55/ACMUsalBot
  2. Seleccionar la insingia a añadir, por ejemplo license para indicar visualmente la licencia usada
  3. Modificar la URL de la imagen (https://img.shields.io/github/license/mashape/apistatus.svg) de la siguiente manera:
    1. En naranaja está el código que indica el tipo de insignia, lo cual una vez elegido no deberías cambiarlo.
    2. En verde, el nombre del usuario que alberga el repositorio (ganchito55)
    3. En rojo, el nombre del repositorio a usar (ACMUsalBot)
  4. Comprobar que se genera la insignia correctamente
  5. Añadir un estilo, si así lo deseas.
  6. Copiar el código Markdown e incluirlo en tu fichero README.md o README

Insignia para mostrar la licencia de tu proyecto en GitHub

Una vez conseguida tu primera insignia, ya solo queda añadir las que consideres necesarias a tu repositorio y actualizarlo:

Las insignias añadidas a mi repositorio de GitHub

Por ejemplo, yo he puesto la licencia, el número de incidencias abiertas y la fecha del último cambio, para indicar la actividad de mi repositorio.

 

Espero que este artículo te sea de ayuda y te animes a compartir, qué insignias utilizas en tus repositorios.

Un saludo.

The following two tabs change content below.

Jorge Durán

Entusiasta de la tecnología desde los 10 años, desarrollador y creador de varios proyectos de software y autodidacta por naturaleza. Ingeniero Informático por la USAL

Latest posts by Jorge Durán (see all)