Protocolo de creación de issues maquetado

Armamos un protocolo para crear issues para el maquetado con el objetivo de que sean lo más estandarizados posible, y que se puedan navegar y visualizar fácilmente

Escrito por~

Crear un issue por cada schema:

  • el formato es "Schema | Nombre del schema"

  • poner "Contiene: #1 #2 #3" donde #1 #2 #3 son el primer nivel de componentes que se encuentra en el schema. Esto significa que si, por ejemplo, tengo un componente navbar #5 dentro del cual se encuentra el componente menú hamburguesa #6, solo figura el #5.

  • si hay issues que todavía no están creados, poner el nombre del componente si se sabe el nombre o puntos suspensivos si no, cosa de saber que falta completar

  • poner ### Testing y debajo los ítems a testear. No incluir nada de lo que corresponda al testeo de cada componente, solo al schema en su conjunto

  • en issues relacionados poner todos los componentes que se ven en el schema, con todos sus subcomponentes

Crear un issue por cada componente:

  • el formato es "Componente | nombre-del-componente"

  • poner "100% ancho: sí/no" según si el componente ocupa el 100% del ancho de pantalla

  • poner "Dentro de: #1" donde #1 es el schema o componente inmediatamente superior. Puede haber varios si es un componente que se encuentra dentro de varios schemas o componentes.

  • poner "Contiene: #1 #2 #3" donde #1 #2 #3 son el primer nivel de componentes que se encuentra en este componente. Esto significa que si, por ejemplo, tengo un componente card-group #7 dentro del cual se encuentra el componente card #8, solo figura el #7.

  • si hay issues que todavía no están creados, poner el nombre del componente si se sabe el nombre o puntos suspensivos si no, cosa de saber que falta completar

  • en issues relacionados poner todos los componentes que forman parte del componente, y también los subcomponentes de éstos

  • poner ### Testing y debajo los ítems a testear. No incluir nada de lo que corresponda al testeo de cada subcomponente.

  • siempre que una clase deba ser personalizable, aclararlo

  • siempre que haya un texto, incluir nivel de encabezado si aplica, tamaño (en píxeles con base 16px), peso (en número), color (en hexadecimal y rgb, preferiblemente), siempre que se tenga esta información. Si no está disponible en el figma, averiguar (en adelante, esto aplica para todos los ítems).

  • siempre que haya un fondo, incluir el color (en hexadecimal y rgb, preferiblemente)

  • siempre que haya un borde, incluir el color (en hexadecimal y rgb, preferiblemente) y grosor

  • incluir border-radius si aplica

  • si hay links, incluir si deberían abrir en pestaña nueva, si deberían tener subrayado, y el color

  • incluir alineación siempre que aplique

  • incluir márgenes y padding siempre que se tenga la información

  • incluir cualquier otra info que aplique, siempre intentando ser lo más explícite posible con los valores (no poner "negro" sino "#000000" etc.) de forma que se vean igual que en el inspector

  • todos los issues van con labels "Skill: Desarrollo" y "Hacer", a menos que haya que averiguar algo con lx cliente, en cuyo caso le ponemos "En espera"

Documentar es un acto de amor, siempre es para otre.

Hecho por Sutty.