Flujo de trabajo de documentación

el tablero del proyecto

Hay un tablero de proyectos de GitHub (un tablero normal de Kanban) que mantiene organizados todos los problemas pendientes: https://github.com/orgs/ bitxor/proyectos/8

Cada problema de GitHub asignado al proyecto Documentación va a este foro. Luego, puede arrastrar y soltar tarjetas para realizar un seguimiento de su progreso hasta que se completen las tareas.

Solo los problemas de GitHub van a este foro, no las solicitudes de extracción. Cuando se crea un RP para solucionar un problema, debe vincularse a él pero no agregarse al proyecto Documentación para que no se muestre en el tablero.

Las columnas son:

• Backlog: Tareas pendientes. Todos los números nuevos van a esta columna. Puede crear problemas, pero también cualquier otra persona en el mundo. En realidad, se fomenta la creación de problemas en el enlace que se encuentra en la parte inferior de cada página del documento (“Danos tu opinión�?.

• Prioridad: Estas son las tareas en las que se debe trabajar a continuación. Cuando termine una tarea, debe ir a esta columna y comenzar a trabajar en la tarea en la parte superior.

• En progreso: Tareas en las que se está trabajando actualmente. El propósito de esta columna es mantener a todos informados sobre lo que está trabajando actualmente.

• Revisión: Tareas finalizadas pendientes de revisión o aprobación. Quién debe aprobar depende de la tarea y de quién la creó.

• Terminado: Tareas finalizadas. Por lo general, los problemas se cierran automáticamente cuando se fusiona su PR vinculado y el problema se mueve automáticamente a la columna Listo.

Periódicamente (¿una vez a la semana?) debe revisar la lista de prioridades, mover las tarjetas para asegurarse de que la lista aún esté actualizada y ponerse en contacto con los capitanes.

Emitir etiquetas

Los problemas están etiquetados para facilitar la organización. Estas son las etiquetas principales:

• Errores

  • P1: La información es incorrecta. Esto debería arreglarse lo antes posible.

  • P2: La información está incompleta.

  • P3: Cuestiones estéticas.

• Sugerencias

  • enhancement: Etiqueta genérica para las cosas que se pueden mejorar.

  • buen primer problema: Tareas sencillas buenas para familiarizarse con el sistema. Los recién llegados deben comenzar con estos.

Use el cuadro de filtro en el tablero del proyecto para mostrar solo problemas con una etiqueta dada, como `` etiqueta: “buen primer problema�?`` por ejemplo.

Pruebas locales

El documento Estructura del repositorio explica cómo probar sus cambios localmente antes de enviar cualquier cambio a GitHub.

vistas previas de relaciones públicas

Cada solicitud de extracción genera una vista previa usando Netlify. El bot netlify agregará un comentario al PR con enlaces al estado y los resultados de la compilación de la vista previa.

Utilice estas vistas previas para asegurarse de que la compilación funcione correctamente y para compartir los resultados con el equipo.