search

gcba / estandares

Estándares y lineamientos de experiencia digital
https://gcba.github.io/estandares/
MIT License
16 stars 5 forks source link

preguntas sobre la wiki de obelisco #85

Closed Vpappacena closed 3 years ago

Vpappacena commented 3 years ago

Leer la wiki y generar un doc con las preguntas que surgen para consultar y ver como avanzar

Vpappacena commented 3 years ago

@armenio-s compartamos el doc con las preguntas sobre la wiki para poder ir avanzando. :)

armenio-s commented 3 years ago

@Vpappacena Dejo los comentarios acá:

La wiki en general está bastante clara y especifica bien los puntos importantes para poder participar en el proyecto o utilizarlo. A continuación detallo algunas cosas que se podrían agregar y dudas sobre diferentes puntos que podríamos ver.

Esta documentación, ¿está orientada al desarrollador solamente o también al diseñador?

Instalación - Requisitos. Además de tener Node instalado, advertir que también debería tener instalado git Es obvio, pero es mejor que aparezca en la documentación.

Formato de código Entiendo que los archivos del linter no deberían tocarse, pero podríamos ver la posibilidad de explicarlos para que la persona que trabaje con el proyecto entienda bien cómo está configurado en caso de que necesite cambiarlo.

Configuración del proyecto Si es relevante, especificar qué comportamientos configuran los archivos dentro de la carpeta .vscode.

Versionado y publicación No queda claro si se está publicando en npm o no… al ingresar a npm no hay info de como instalarlo en tu proyecto si es que está disponible.

Subir código al repositorio ¿Qué pasa si se rechaza el PR y quién aprueba o rechaza ese PR?

Sección "crear o modificar un componente"

Entender los casos de uso ¿Dónde está esta documentación? Debería estar linkeada en esta sección.

Diseñar la solución Se podría agregar un link que lleve al listado de componentes de Bootstrap para tomar de referencia.

**Más adelante en otra sección se indica como pedir los casos de uso y crear los casos de uso. Quizás esa información debería estar antes de esto o en conjunto con esto para poder entenderlo mejor.

Agregar las historias a storybook Sería bueno agregar un link a la documentación de storybook para profundizar un poco más sobre cómo funciona el componente y qué son las stories, o directamente explicarlo en la wiki y dejar el link como extensión de esa expliación.

El link “El archivo de ejemplo para las historias” está roto.

Componentes No queda claro si puedo usar HTML estático para crear un componente. Dice que se puede, pero que recomienda usar react (Todo el proyecto utiliza esta librería). ¿Cómo conviviría un componente creado en HTML estático con sus stories en este proyecto creado en react? ¿O se refiere al HTML que se agrega en el componente de react?

Las informaciones sobre creación de casos de uso, reporte de errores y aporte de código, tal vez se podrían integrar a la sección de procesos de trabajo, ya que son parte del proceso o “camino” que se lleva adelante para tomar decisiones de hacer ajustes o crear nuevos componentes.