contributing.md

Introducción

Primero que nada, gracias por tu interés en contribuir al proyecto. Este es el espíritu de Open Source UC <3.

Estos lineamientos buscan facilitar el esfuerzo de contribuir a este proyecto, por lo que te pedimos leerlos antes de ponerte a trabajar.

Workflow

Para contribuir a este repositorio, esperamos que aportes estén en el formato de Pull Requests (PRs) hacia el branch development del proyecto. Esto nos permite revisar tu código, darte feedback y evitar que se publiquen errores.

En general, este es el proceso estándar para contribuir código:

• (Opcional) Discutir tu propuesta previamente creando una issue.

• Hacer fork del repositorio para hacer tus cambios, o si tienes los permisos, crear una nueva branch bajo el mismo repositorio. Si ya tienes un fork, debes sincronizar tu repositorio con upstream:

  • Hacer un pull request y merge desde la branch development de este repositorio hacia development de tu fork

  O

  • Desde github, usar "fetch upstream" y "fetch and merge" para hacer lo mismo pero con menos pasos

• Crear una branch basada en la branch development, en lo posible dale un nombre significativo a tu nueva branch, ej add-project-images.

• Crear un Pull Request (PR) a development, manteniéndolo como "borrador" (draft) hasta que esté listo para ser incorporado.

• Explicar brevemente los cambios, siguiendo el formato de Pull Requests, especificando posibles problemas o puntos de discusión.

• Solicitar una revisión de pares (review) a los integrantes del equipo del proyecto (los encuentras en la seccion de Maintainers del readme).

• Una vez aprobada la PR, un maintainer miembro del proyecto hará merge del código a development, una vez hecho el merge puedes eliminar tu branch.

Puedes encontrar mas detalles sobre este proceso aquí.