Guía para Contribuidores

🖐 ¡Bienvenid@s a la comunidad Open Source Bancolombia! Estamos muy felices por tener tu interés en contribuir a nuestra comunidad. En esta guía encontraras información necesaria para entender nuestro flujo de contribución.

¿Cómo puedo contribuir? 🤷‍♀️

El repositorio de la comunidad Bancolombia esta abierto al publico con múltiples proyectos, en los cuales se pueden contribuir de manera abierta, sin requerir solicitudes de acceso del equipo Bancolombia.

Flujo de contribución:

1. Selecciona el proyecto que sea de tu interés.

2. Crea o selecciona un Issue por resolver, debes generar "discusión" informando tu interés en solucionar el issue. De allí, el equipo decidirá si lo acepta y si asigna la capacidad.

3. Valida la rama asociada al issue, en la cual realizarás tus cambios, seleccónala y haz clic en el botón 'Fork' en la esquina superior derecha del proyecto con todas las ramas.

4. Clona tu copia del repositorio a tu máquina local.

5. Has la contribución en la rama de interés en tu fork.

6. Ve a la página de Pull Requests en el repositorio original y crea un nuevo Pull Request desde tu rama a la rama correspondiente.

Flujo de Contribución ✨

Haz clic aquí para ver la imagen en tamaño completo.

En el proceso de contribución, debes tener presente los lineamientos dados para la comunidad Open Source Bancolombia.

Gestión de issues 💡

Los issues constituyen una pieza clave en la colaboración y organización del desarrollo de software Open Source. Una adecuada gestión de estos permite una comunicación eficiente, organización clara del trabajo pendiente y una participación transparente de la comunidad.

Los mantainers y contribuidores del proyecto pueden abrir issues para reportar incidencias, sugerir mejoras o hacer preguntas.

Existen etiquetas definidas por la comunidad Open Source Bancolombia que seran obligatorias. Sin embargo, cada proyecto puede tener etiquetas que le ayuden dentro de su proceso ágil.

Para más detalle de como gestionar issues: desde su creación, etiquetado y discusión, hasta su eventual aprobación o rechazo por favor consulta la documentación disponible Lineamientos de Contribución

Estructura y uso de branches 🌳

Al realizar contribuciones a nuestros proyectos Open Source, deberás trabajar a partir de una copia (fork) del proyecto en el que estés colaborando. En estos casos, tendrás la responsabilidad de adoptar un flujo de trabajo estructurado; te recomendamos utilizar Trunk-based, un modelo que emplea principalmente dos tipos de ramas:

• trunk o main: Única rama principal, donde se integran cambios directamente.
• release : Versiones liberadas.

Documentación inicial 📋

La documentación base de un proyecto Open Source es fundamental para asegurar que todos los colaboradores comprendan y puedan contribuir eficazmente al proyecto. Esta documentación incluye: Información funcional, Documentación Técnica, Estándares, políticas, guías de contribución.

Existen algunos tipos de archivos que nos permitiran manejar documentación dentro de los proyectos de la comunidad Open Source Bancolombia, como los son:

README 📋

En el README.md encontrarás la información introductoria del proyecto. Te recomendamos lo leas detenidamente para que puedas consumirlo y tener tu punto de partida en la contribución al mismo.

LICENSE 📋

El archivo LICENSE.md contiene la licencia y las restricciones de uso para el código fuente, al tratarse repositoros Open Source esta abierto a licencias que pueden permitir, el uso, modificacion, copia, etc. del Código fuente, como por ejemplo (MIT license, Apache-2.0 license).

Además, el documento proporciona un correo electrónico de contacto para preguntas o comentarios sobre su contenido.

CODE_OF_CONDUCT 📋

Este archivo CODE_OF_CONDUCT.md establece las normas de comportamiento y conducta esperadas tanto para los contribuidores como para los usuarios del proyecto. El código de conducta tiene como objetivo fomentar un ambiente colaborativo, inclusivo y respetuoso para todos los participantes involucrados.

CONTRIBUTING 📋

El archivo CONTRIBUTING.md es un documento que se encuentra en la raíz de un repositorio de código y tiene como objetivo ayudar a los contribuidores a entender cómo pueden participar en el proyecto. Define las expectativas, procedimientos y reglas que deben seguirse para contribuir de manera efectiva y respetuosa. Guía de manera practica a nuevos contribuidores y explica detalladamente el flujo del proyecto, permitiendo que sea facíl de entener y de iniciar a contriuir.

Una guía de contribución de proyecto abarca la estructuración de la propuesta, la planificación detallada y la ejecución, seguimiento de las actividades, la definición clara del proyecto, sus objetivos, el equipo y la metodología.

GETTINGSTARTED 📋

El archivo GETTINGSTARTED.md es una guía que proporciona instrucciones para configurar el entorno local del proyecto. Incluye una lista de las herramientas de software necesarias y una guía paso a paso para la instalación.

Plantillas de Pull-Request 📋📤

Para la comunidad Bancolombia se determino algunas plantillas que seran automaticamente cargadas en cada uno de los procesos que lo necesiten, de manera que sea mas eficiente el proceso.

Puede validar las plantillas actuales en 👉Template PR

Definición de roles y responsabilidades 📜

Cada proyecto Open Source tendra personas con roles específicos como Project Lead, Mantainer o Contributor, que son fundamentales para la seguridad, como para la eficiencia en el trabajo en equipo en un proyecto Open Source.

Para conocer mas sobre como convertirse en Maintainer o Trusted Committer: 👉 Como ser.

Canales de comunicación 📧💻

Puedes comunicarte mediante el correo oficial del equipo de Open Source:

👉 oficina_open_source@bancolombia.com.co

Este canal está disponible para consultas generales, solicitudes de apoyo o para escalar temas que requieran atención específica.