Contributions

Este documento tiene como finalidad brindar toda la información necesaria para que desarrolladores y colaboradores puedan contribuir de forma efectiva. Aquí encontrarás instrucciones para configurar el entorno de desarrollo, así como pautas generales para contribuir al proyecto.

1. Requisitos

Antes de comenzar, asegúrate de tener instaladas las siguientes herramientas y configuraciones básicas en tu máquina:

• Java JDK 25
• Git
• Editor de código (VS Code, IntelliJ IDEA, ...)

2. Configuración

2.1. Archivo settings.xml

Para poder acceder a los artefactos SNAPSHOT del proyecto, hay que seguir estos pasos:

1. Ubicación del archivo: Coloca el archivo settings.xml en el directorio ~/.m2.
2. Contenido básico: El archivo debe incluir la siguiente configuración:

<settings>
  <servers>
    <server>
      <id>github</id>
      <username>{tu usuario github}</username>
      <password>{tu PAT}</password>
    </server>
  </servers>
  <profiles>
    <profile>
      <id>wakamiti</id>
      <repositories>
        <repository>
          <id>github</id>
          <url>https://maven.pkg.github.com/wakamiti/*</url>
          <snapshots>
            <enabled>true</enabled>
            <updatePolicy>always</updatePolicy>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>github</id>
          <url>https://maven.pkg.github.com/wakamiti/*</url>
          <snapshots>
            <enabled>true</enabled>
            <updatePolicy>always</updatePolicy>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>wakamiti</activeProfile>
  </activeProfiles>
</settings>

Important

Asegúrate de reemplazar {tu usuario github} y {tu PAT} con tus datos reales. En el siguiente apartado de detalla cómo obtener un PAT.

2.2. Creación del PAT (Personal Access Token)

Para generar el token personal necesario para la autenticación en GitHub Packages, realiza los siguientes pasos:

1. Accede a Github: Ingresa en tu cuenta y dirígete a Settings > Developer settings > Personal access token.
2. Genera un nuevo token: Haz click en Generate new token y asegúrate de incluir el alcance read:packages para poder acceder a los paquetes.
3. Configura el token: Una vez generado ya lo puedes utilizar en tu fichero settings.xml.

3. Guía para contribuir

Si deseas contribuir al proyecto, sigue estas recomendaciones:

• Clona el proyecto: Utiliza Git para clonar el repositorio en tu entorno local.
• Crea una rama de trabajo: Trabaja en una rama nueva basada en la rama develop para cada nueva característica o corrección. En este proyecto seguimos un modelo de ramas basado en GitFlow.
• Añade tu código: Añade todos los cambios a la nueva rama y actualiza el CHANGELOG.md con el detalle de los cambios realizados.
• Crea un Pull Request (PR): Una vez completados y probados los cambios, crea un PR a la rama develop para revisión y discusión.