Cheatsheets de TIC

Este es el repositorio de la web de cheatsheets de TIC. Para acceder a la web hacer click acá.

¿Cómo hago un cambio?

¿Mi cambio tiene que ser fundamental?

No. Todos los cambios son importantes, incluso si el cambio únicamente incluye agregar una tilde en este mismo documento. Cada uno puede aportar su parte para mejorar la calidad de este (y otros...) repositorios. De eso se trata la filosofía Open Source, no es necesario saber programar mejor que otro, o entender más de un lenguaje u otra herramienta, todos cometemos errores y cualquiera puede ser capaz de corregirlos. Incluso si el cambio no es significativo, es una buena forma de practicar el proceso que conlleva realizar una pull request (PR).

Pasos a seguir

Para proponer algún cambio que agregue información o mejore algo en el repo hay que seguir los siguientes pasos:

• Hacer un fork al repo
• Realizar algún cambio detallando en el/los commits (utilizando conventional commits) lo realizado
• Hacer un PR con el/los commits realizados
• Esperar la respuesta al PR

Convención para el commit message

Para los commits, vamos a utilizar una convención llamada conventional commits. El proyecto está configurado para que no se pueda committear si no se sigue esta convención.

Importante si usas linux o mac: correr npm run unix una vez o no van a poder commitear.

Ejemplo de PR

En esta sección podemos ver un ejemplo de un PR que realizó @Sponja para arreglar un problema en el índice del cheatsheet de PHP.

El PR puede recibir una respuesta positiva o negativa, si la respuesta es positiva el cambio se acepta y si es negativa se rechaza, lo que no significa que la corrección o el arreglo no es necesario, sino que tal vez es necesario mejorar la corrección antes de aceptarla.

Una vez que el PR es aceptado, el cambio se aplica al repo y se generará un nuevo commit con el cambio, como el que podemos ver en este commit.

Agregar nuevos cheatsheets

Si se quiere agregar un nuevo cheatsheet de algún lenguaje o herramienta que no se encuentra en el repo, ésta debe ser agregada en formato de archivo .md, en la carpeta /cheatsheets/ con el nombre del lenguaje o la herramienta en cuestión. Es importante, además de seguir los pasos en la sección anterior, cumplir los requerimientos obligatorios.

Requisitos

• Agregar además del .md un logo correspondiente en la carpeta /assets/images/ que debe estar en formato svg y debe tener el mismo nombre que el archivo .md (ejemplo: php.md y php.svg). Intentar que el logo tenga un tamaño adecuado de alrededor de 20x20px, para que se vea bien en la web.

• Tener una sección de metadata que tenga la siguiente estructura:

---
title: {título}
---

• La primer sección debe ser llamada "Índice" y debe contener una tabla de contenidos (TOC), con la misma estructura que la presente en los cheatsheets que se encuentran actualmente en la carpeta /cheatsheets/, seguida de un <br> por razones puramente estéticas

Recomendaciones

• Citar las fuentes de información para acelerar el proceso de verificación y validación
• Hacer uso de las herramientas que brinda markdown para mejorar la legibilidad de la información, aligerando también el proceso de feedback