Skip to content

Maintainers

  • Anthuan Vasquez
  • Isaac Martinez
  • Jose Genao

Minnek Versioning Convention (MVC) para BC y Shopify

Este documento detalla las prácticas recomendadas para el versionado de temas en las plataformas de ecommerce BigCommerce y Shopify. Se seguirá un enfoque semántico de versionado y se establecerán pautas para la gestión de ramas en entornos de desarrollo, prueba y producción.

Versionado Semántico

El versionado semántico se utilizará para garantizar una gestión coherente de versiones en los temas de las tiendas. La estructura de versión será <MAJOR.MINOR.PATCH> [TICKET_ID], y se seguirán las siguientes reglas:

  • MAJOR: Se incrementa cuando se realizan cambios incompatibles en la estructura o funcionalidad del tema. En nuestro caso también cuando un sitio pasa de desarrollo a producción.
  • MINOR: Se incrementa cuando se agregan nuevas funcionalidades de manera compatible con versiones anteriores.
  • PATCH: Se incrementa para correcciones de errores o ajustes que no afectan la compatibilidad con versiones anteriores.
  • TICKET_ID: Este es un valor opcional y temporal que se utiliza para indicar a que ticket pertenece una version. Se usa para mostrar los cambios a QA y el cliente, y se debe eliminar una vez se haya hecho el deploy de dicho ticket.

Desarrollo

  1. Cuando se comienza un sitio desde cero, la versión inicial será 0.1.0. La versión MAJOR se incrementará al finalizar el desarrollo y el sitio este live.
  2. Si hay múltiples tickets abiertos y se necesita aplicar el tema en un entorno de prueba, se creará una rama test que incluirá todas las funcionalidades listas para probar.
  3. Para el entorno de prueba, se creará una rama a partir de master con el formato test/[version_number]. La versión se mantendrá en la misma convención. Ejemplo: test/0.2.

Mantenimiento y soporte (el sitio esta live)

  1. Cuando el sitio ya está en producción o live y se necesitan realizar pruebas más exhaustivas antes de aplicar el tema. Se debe subir el tema utilizando como convención la versión actual más el ID del ticket. Ejemplo: 1.2.0 TLS-5.
  2. Una vez que el tema pasa QA y UAT, el theme para esa versión se debe eliminar inmediatamente.
  3. Luego se debe hacer un release y mezclar con master.
  4. Finalmente en master se debe hacer un deploy para luego aplicar el theme o notificar al cliente de que esta listo para aplicarse.

El seguimiento de estas pautas de versionado y gestión de ramas asegurará un flujo de trabajo ordenado y eficiente para el desarrollo, prueba y despliegue de temas en las plataformas BigCommerce y Shopify. Además, facilitará la identificación y corrección de problemas en diferentes etapas del ciclo de vida del desarrollo del tema.

Interested to join the team?

Learn more about our recruitment process and open positions.

Join

Join in and collaborate to make our Handbook an even better tool!