Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 6.46 KB

CONTRIBUTING.md

File metadata and controls

81 lines (51 loc) · 6.46 KB

SismoMX - Como ayudar

¡Hola! Sí estás aquí es porque quieres sumarte de alguna manera a los esfuerzos de nuestra comunidad, ¡bienvenidx!

Lo Básico

Es indispensable que tengas una cuenta de GitHub para que puedas ver las necesidades que tiene cada área y proyecto (aquí un manual rápido si no sabes qué es GitHub).

Es indispensable que tengas una cuenta de Slack y te unas al grupo del proyecto en el que hayas decidido colaborar (si no tienes usuario, ahí lo creas y listo)

Por el momento tenemos 3 grandes áreas que necesitan de tu colaboración:

Área de Datos

Estamos recolectando, limpiando, consolidando y analizando datos.

Área de Desarrollo

Estamos desarrollando proyectos de Software para ayudar a la población.

Otros

Diseño, documentación, y otras actividades de apoyo a otras áreas

Súmate a un Equipo de Trabajo

A continuación te presentamos tabla en donde puedes encontrar: (1) los equipos de trabajo existentes; (2) el canal de Slack que están usando como medio de comunicación; y, (3) la descripción del proyecto en el que están trabajando.

Equipo Slack Descripción
Comunicación #sismomx-comunicación Tareas de comunicación, monitoreo de redes y vinculación con otras organizaciones.
Data #sismomx-data Tareas de limpieza, validación, análisis y ETL de datos.
Desarrollo #sismomx-desarrollo Tareas de desarrollo para todos los proyectos. Súmate si buscas ayuda o cómo contribuir.
Diseño #sismomx-diseño Tareas de diseño de UI/UX para múltiples proyectos. Ofrece y busca ayuda de diseño para proyectos.
Docs #sismomx-docs Tareas de documentación de procesos y repositorios.
GitHub #sismomx-github Ayúdanos a revisar y hacer merge de PR's en los distintos repositorios.
Mapas #sismomx-mapas Tareas de mapeo y trabajo con datos geográficos.
Webiste #sismomx-website Ayúdanos a actualizar el sitio web del proyecto.

Esto es lo que tienes que hacer para sumarte a un equipo de trabajo ya que los revises y decidas en cuál quieres trabajar:

  1. Haz click en el nombre del grupo de trabajo ahí en la misma tabla donde se presentan. El click te va a llevar al centro de control, donde se estarán agregando todas las tareas pendientes por realizar como “issues”.
  2. Dentro de los issues busca la titulada “PRIORIDADES Y RESPONSABLES” para que puedas conocer los objetivos del día, así como los horarios de quiénes de lxs responsables del grupo estarán disponibles en slack para contestar tus preguntas.
  3. Ya que decidas en cuál de las prioridades quieres trabajar, regresa a la pantalla principal y busca la tarea en la que te gustaría trabajar (mediante los labels puedes encontrar las tareas clasificadas por área de interés):
  4. También busca cuáles “issues” piden ayuda mediante el label o la etiqueta “help wanted”:
  5. Dale click al issue y revisa quién lo creó. Mediante @ coméntale que te interesa trabajar en la tarea, y si no se ha asignado a alguien, ¡adelante en lo que te responden! Si tienes preguntas no olvides que puedes buscar al encargadx en el horario en el que te encuentres.
  6. Por último, si ya te tienes que ir, por favor documenta tus avances y trata de definir qué es lo que todavía queda pendiente por realizar si es que no terminaste la tarea seleccionada.

Otros Temas Importantes

Para un proyecto de desarrollo de software:

Lee el README del proyecto e instala el proyecto, las instrucciones deberán estar en ese documento.

Si las instrucciones no están en ese documento, documentar la instalación del proyecto será tu primera tarea

Para otros proyectos:

Me gustaría que cambiaran algo en el proyecto

En primer lugar accede a la sección de issues del proyecto y busca si ya alguien ya levantó un issue igual o similar.

Si lo encuentras pregunta cómo puedes ayudar a resolverlo más rápido. Si no, agrégalo como nuevo issue y busca al responsable en el horario en el que te encuentras para platicarlo.

Detecté un error

Un error / bug es cuando “algo” no se comporta de la manera que esperamos, puede ser un sitio web que no carga o el diseño de un folleto que no incluye el número de teléfono de la cruz roja. Un error NO es agregar algo que no se espera o que no estaba definido en primer lugar (Por ej. agregar un widget de redes sociales no se clasifica como un error si no se había solicitado antes, es algo “nuevo”).

Entonces, si encuentras un error, levanta un issue donde lo reportes, agregando la etiqueta “bug” y en la sección de comentarios describe lo que se necesita arreglar de la siguiente manera:

  1. Siendo {agrega aquí quién eres o por qué estás usando la herramienta}, quiero hacer {acción} para poder {objetivo}
  2. Sin embargo {agrega aquí la descripción del problema}
  3. Los pasos que realicé fueron:
  4. El resultado obtenido fue:
  5. El resultado esperado era: (Es importante definir POR QUÉ se espera ese resultado, por ej. ¿Se definió en algún documento? etc)
  6. El entorno en el que sucedió es {agrega el contexto, si solo se puede reproducir el bug en algunas circunstancias (navegador (chrome, safari, etc), hora del día, etc)}

Tengo una idea

Si tienes una idea o “feature request” para mejorar un proyecto y no la encontraste en los issues del proyecto comparte tu idea en el canal para escuchar las opinones de otros contribuidores.

Si la idea es apoyada levanta un issue nuevo en el repositorio del proyecto y etiquetalo como feature