Contribuir

Workflow seleccionado "Git Flow"

El workflow Git Flow, creado por Vincent Driessen en 2010, organiza el desarrollo del código en dos ramas principales:

  • master: Contiene el código en producción.
  • develop: Contiene el código en pre-producción.

Además, utiliza ramas auxiliares para distintas etapas del desarrollo:

  • feature*: Para nuevas funcionalidades (se crean desde develop y se fusionan en develop).
  • hotfix*: Para corregir errores críticos en producción (se crean desde master y se fusionan en master y develop).
  • release*: Para preparar nuevas versiones de producción (se crean desde develop y se fusionan en master y develop).

¿Cómo puedo contribuir?

Nos emociona que estés interesado en contribuir a nuestro proyecto. Esta guía está diseñada para ayudarte a entender cómo puedes colaborar con nosotros, ya sea corrigiendo errores, mejorando la documentación, agregando nuevas características o cualquier otra forma de contribución que desees realizar.

Para incorporar una función en la rama main, simplemente se crea un "PR" (Pull Request), que deberá ser aprobado por algún colaborador. Cualquier colaborador puede hacerlo, o bien, si no requiere revisión, puede ser aceptado por quien esté incluyendo la funcionalidad.

Es crucial que el nombre de las ramas creadas sea lo más descriptivo posible. Por ejemplo, si trabajamos en una nueva funcionalidad relacionada con la API, la rama se debe llamar como referencia a la funcionalidad en cuestión. En el caso de tratarse de la corrección de un error en el código de la API, la llamaremos fix-api.

Este proceso asegura un flujo de trabajo ordenado y facilita la colaboración entre los miembros del equipo.

Los pasos para contribuir en este proyecto como individuo son:

  1. Forkear el repositorio (git fork)
  2. Crear una nueva rama para la función (git checkout -b feature/AmazingFeature)
  3. Publicar la rama en el repositorio remoto(git push --set-upstream origin <nombre-de-la-nueva-rama>)
  4. Commit los cambios (git commit -m 'Add some AmazingFeature')
  5. Push a la rama (git push origin feature/AmazingFeature)
  6. Abrir un Pull Request dirigido a la rama develop

Commits

Los commits convencionales nos permiten mantener la organización al realizar los commits y facilitan la creación de releases de forma automatizada.

Se basan en el uso de palabras clave al inicio del mensaje de cada commit, de la siguiente manera:

  • feat(tema de la modificación): Breve explicación: Para cambios significativos o nuevas características.
  • fix(tema de la modificación): Breve explicación: Para correcciones pequeñas.
  • chore(tema de la modificación): Breve explicación: Para cambios menores insignificantes para el usuario.
  • docs: Breve explicación: Para cambios que se realizan a la documentación.