gcm1001 / TFG-CeniehAriadne

CENIEH & Ariadne+ project.
GNU General Public License v3.0
3 stars 2 forks source link

Evaluar la calidad del código #45

Closed gcm1001 closed 4 years ago

gcm1001 commented 4 years ago

Herramientas a considerar:

gcm1001 commented 4 years ago

Herramienta escogida

La opción escogida ha sido Codacy ya que, de entre las tres propuestas, es la que está más enfocada a la revisión de código automatizada, que es lo que nos interesa. Como es lógico, soporta todos los lenguajes de programación que estoy utilizando ( PHP, HTML, JavaScript y CSS ). Además, la configuración de repositorios es muy sencilla gracias a su sencilla y elegante interfaz gráfica.

Configuración

Como he dicho antes, la utilización de esta herramienta es muy simple. Simplemente hay que registrarse en su página oficial utilizando para ello la cuenta de Github, dar permisos a la aplicación, escoger una organización (si perteneces a alguna) y, por último, seleccionar el repositorio que quieras analizar. A partir de este momento, la herramienta analizará todo el código del repositorio cada vez que se ejecute un commit sobre la rama principal.

En mi caso, solo me interesa que analice la parte de código que estoy desarrollando, es decir, todos los ficheros alojados en la carpeta PLUGINS y THEMES pertenecientes a la carpeta OMEKA. Además, también es conveniente que analice todos los ficheros que he desarrollado para el despliegue automático (ficheros .yaml .yml).

Para configurar las carpetas ignoradas, en la pestaña Settings > Ignored Files, hay que seleccionar todas las carpetas que no he mencionado anteriormente.

Screenshot_20200517_103547

Además se pueden realizar otras configuraciones importantes como:

Codacy Badge

clopezno commented 4 years ago

Añade una tarea en GitLab llamada a mantenimiento y calidad de código Codacy donde analices en detalle los informes de codacy e intentes resolver algunas de las issues para mejorar la calidad y pasar a una evaluación de B.