Guía para colaborar en repositorio

Guía para Colaborar en el Repositorio GitHub de API-IDEE

1. Crear un "Issue"

El primer paso para contribuir a un proyecto es crear un issue en el repositorio. Esto sirve para definir el trabajo que se va a realizar y brindar contexto al equipo.

Nomenclatura de los Issues

Es importante usar una nomenclatura adecuada al crear un issue. El nombre debe reflejar el control, plugin, o componente que se va a trabajar, seguido de una breve descripción del cometido. Por ejemplo:

• [Control][scale] Corregir bug para que se muestre correctamente la escala.
• [Plugin][information] Corregir bug que hace que no se vea correctamente el GFI cuando tiene activado el parámetro inteligente el Popup.
• [Core][Vector] Mejorar la fuente de datos Vector para que permita transformaciones al vuelo.

Cuerpo del Issue

Dentro del cuerpo del issue, se debe incluir:

• Descripción detallada del cometido, incluyendo cualquier información relevante o contexto para la tarea.
• Cualquier otra información que facilite el entendimiento del trabajo que se debe hacer.

Ejemplo de cuerpo de un Issue:

Descripción:

• En este issue se abordará la mejora de la fuente de datos vector pudiendo permitir transformaciones al vuelo en un visualizador.
• Para ello habrá que asignar un EPSG a la geometría en la hora de la construcción de un objeto geográfico Información adicional:
• Habrá que tener en cuenta los casos de usos actuales para evitar posibles problemas con visualizadores ya creados.

Usar Etiquetas (Labels)

Es fundamental clasificar los issues utilizando etiquetas (labels) para poder organizar y filtrar las tareas de manera eficiente.

Si los labels existentes no son suficientes, podemos crear nuevos labels que se ajusten mejor a las necesidades del proyecto.

Asignar el Issue a un Projecto

Si el proyecto tiene diferentes iniciativas o expedientes, puedes asignar el issue a un Project específico. Esto ayudará a diferenciar las tareas según el expediente de origen.

2. Crear un fork del repositorio y una rama para el Issue

Una vez creado el issue, el siguiente paso es crear un fork del repositorio, desde el cual crearemos una rama a partir de develop. Esta rama debe tener un nombre que sea representativo del trabajo que se va a realizar.

Ejemplo de Nombre de Rama:

feat_1_eventos-Locator

El nombre debe seguir el patrón:

• feat: para nuevas funcionalidades.
• bugfix: para corregir errores.
• hotfix: para correcciones urgentes.
• chore: para tareas generales de mantenimiento.

Asignación de la rama con el Issue

Una vez creada la rama, se debe asignar al Issue la rama del fork en la que se está trabajando en al sección desarrollo (development)

3. Crear un Pull Request

Cuando la rama con los cambios está lista para ser revisada, crea un Pull Request (PR) desde la rama "feat" hacia la rama develop.

Proceso:

1. Ve a la pestaña "Pull requests" en el repositorio.
2. Haz clic en "New Pull Request".
3. Selecciona la rama develop como destino y la rama con el desarrollo realizado como origen.
4. Añade una descripción detallada del PR, haciendo referencia al issue correspondiente. Para ello, en la issue, se hará referencia al P.R.
5. Revisa los cambios y asegúrate de que todo esté correcto.

4. Revisar y Fusionar el Pull Request

Una vez que se ha creado el Pull Request, se debe realizar una revisión de código por parte de otro miembro del equipo. Si todo está correcto, el PR puede ser fusionado con la rama develop.

Resumen del Proceso de Colaboración

1. Crear un Issue con una descripción clara y con la información necesaria.
2. Añadir Etiquetas para clasificar el trabajo.
3. Asignar el Issue a un Project si corresponde.
4. Crear un fork y una Rama desde develop vinculada al issue.
5. Crear un Pull Request hacia develop.
6. Revisión y Fusión del Pull Request.

Este flujo de trabajo garantiza que todos los colaboradores puedan seguir un proceso organizado y eficiente, facilitando la colaboración en el repositorio.