Hace unos meses, me atreví a crear una solución definitiva para todas las personas que usaban Chakra UI + Storybook, a continuación comparto el post donde explico como inicio todo esto:
Primer Error: Configuraciones
Luego de esa primera contribución, 2 personas levantaron Issues a partir de la solución que propuse; ya que rompe sus pruebas visuales:
¡Cuánta razón! No había contemplado cuando no quieres que se vea el botón en el resto del flujo. Por esta razón, procedí a agregar opciones para que el usuario pueda configurar el botón.
Una buena documentación
Usualmente me suelo encontrar librerías que tienen claros todos los parámetros, valores permitidos y predeterminados; justo repliqué eso:
Las documentación de las librerías que he visto suelen tener una estructura en común:
- Título y badges de estabilidad, compilado y pruebas
- ¿Cómo instalarlo?
- ¿Cómo se usa? (Ejemplo rápido)
- Configuraciones
- Parámetros
- Casos Generales
- Casos Específicos
- Preguntas Frecuentes
No es la clásica documentación de un proyecto en desarrollo, es distinto. Solo empiezas a notar estos detalles cuando te toca hacerlo a ti.
Segundo Error: Mantenimiento
No me explicaron los motivos por los cuales cerraron mi PR; pero, es claro que una de esas razones, es el esfuerzo que conlleva mantener lo que estoy proponiendo.
La solución más acertada es moverlo al toolbar donde no afecta las pruebas de nadie; en otras palabras, una solución de raíz.
Reflexión Final
No quiero entrar en muchos detalles técnicos, pero aprendí que debo contemplar todos los aspectos del flujo de desarrollo cuando se trata de algo que va a ser muy utilizado (sobretodo producción).
Siempre debes velar por el mantenimiento de la aplicación y consultar la mejor opción con el equipo.