@hotelinking/alpha NPM

Como actualizar esta guía

Mantener esta guía actualizada y coordinada con todo el equipo es importante para la productividad de todos.

Nuestro sistema de diseño es un organismo dinámico, constantemente se encuentran mejores soluciones para los problemas que ya hemos planteado en el pasado y no queremos negarnos la posibilidad de poder actualiza la experiencia del usuario en aplicaciones que ya están construidas.

La ventaja de utilizar un sistema de diseño es que podemos aplicar estas mejoras a todas nuestras plataformas y aplicaciones y no solo a aquella en la que estamos trabajando.

Sin embargo este proceso de actualización requiere la consecución de unos pasos que tienen que hacer siempre que este sistema de diseño sea modificado:

Antes de modificar esta guía tienes que hablar con el responsable de desarrollo front o su responsable asignado y obtener su permiso para hacerlo. Este paso es indispensable para poder mantener esta guía ordenada y coordinada con todos.

Desarrollar las modificaciones al componente en el repositorio de la librería de componentes, incluyendo la actualización de sus tests (si los tuviera)
Modificar esta guía de estilos actualizando el nuevo estado del componente y la documentación del mismo
Actualizar el Storybook relativo a este componente para que represente el estado actual del mismo
Coordinar este cambio con el resto de proyectos para que usen la versión más actualizada del componente.

Anatomía del componente

component.vue: El componente component.stories.js: La previsualización y sus combinaciones en storybook component.spec.js: Si el componente requiere algún tipo de unit testing index.js: La exportación del componente para que el index.js general pueda incluirlo en la librería

Publicar

Una vez hechas todas las modificaciones:

hacer un build de storybook npm run build-storybook Subir a (https://zeit.co/home) NOW: now --prod

hacer un build de la librearía en NPM

Cambiar el número de versión de la librería en package.json Si se ha añadido un componente nuevo es un cambio "minor" ( por ej: 0.5.0) Si se ha corregido o modificado un componente es un cambio "hotfix" (por ej: 0.5.1) SI es un cambio en la estructura o algún cambio relevante en la forma de trabajar del equipo es un cambio de versión "major" (por ej: 1.5.1)

Construir la librería: (Se requieren credenciales) npm run build-lib

Publicar la librería en NPM npm publish --access public

Subir todos los cambios al repositorio (Se requieren credenciales)