Skip to content

Latest commit

 

History

History
153 lines (103 loc) · 4.48 KB

CONTRIBUTING.adoc

File metadata and controls

153 lines (103 loc) · 4.48 KB

Contribuir a Alba

¡Bienvenido al proyecto Alba! Estamos emocionados de que estés interesado en contribuir. Ya sea corrigiendo errores, agregando funcionalidades, mejorando la documentación o reportando problemas, tus aportes son muy valiosos.

Esta guía explica cómo puedes contribuir de manera efectiva a Alba. Por favor, léela detenidamente antes de realizar cualquier contribución.

Cómo Contribuir

Reportar Problemas

Si encuentras un error o tienes una pregunta sobre Alba, abre un issue en [GitHub Issues](https://github.com/Angel-Raa/Alba/issues). Al reportar un problema:

  • Proporciona un título claro y descriptivo.

  • Incluye pasos detallados para reproducir el problema.

  • Comparte registros, mensajes de error o capturas de pantalla si aplica.

  • Menciona la versión de Alba que estás utilizando.

Ejemplo:

Título: NullPointerException al acceder a atributos de la solicitud

Descripción:
Al llamar a `request.getAttribute("key")`, se lanza una NullPointerException si el atributo no está configurado. Esto ocurre en la versión 1.0.0.

Pasos para Reproducir:
1. Crear un nuevo objeto Request.
2. Llamar a `request.getAttribute("nonexistentKey")`.
3. Observar la NullPointerException.

Comportamiento Esperado:
El método debería devolver `null` en lugar de lanzar una excepción.

Sugerir Mejoras

Si tienes ideas para nuevas funcionalidades o mejoras, abre un issue etiquetado como mejora. Al sugerir mejoras:

  • Describe claramente la funcionalidad o mejora.

  • Explica por qué sería beneficiosa.

  • Proporciona ejemplos o casos de uso si es posible.

Enviar Pull Requests

¡Aceptamos pull requests (PR)! Para enviar un PR:

  1. Haz un fork del repositorio y clónalo localmente.

  2. Crea una nueva rama para tus cambios:

git checkout -b feature/tu-nombre-de-funcionalidad

  1. Realiza tus cambios y asegúrate de seguir los estándares de codificación.

  2. Escribe pruebas para tus cambios (si aplica).

  3. Confirma tus cambios con un mensaje claro y conciso:

git commit -m "Agregar funcionalidad: descripción de los cambios"

  1. Sube tu rama a GitHub:

git push origin feature/tu-nombre-de-funcionalidad

  1. Abre un pull request en [GitHub Pull Requests](https://github.com/Angel-Raa/Alba/pulls).

Nota: Asegúrate de incluir una descripción de los cambios, el problema que resuelve y cualquier contexto relevante.

Guías de Desarrollo

Configurar el Proyecto

Para configurar el proyecto localmente:

  1. Clona el repositorio:

git clone https://github.com/Angel-Raa/Alba.git
cd Alba

  1. Construye el proyecto usando Maven:

mvn clean install

  1. Ejecuta el servidor:

java -jar target/alba.jar

Estándares de Codificación

  • Sigue las convenciones de código Java descritas en la [Guía de Estilo de Google para Java](https://google.github.io/styleguide/javaguide.html).

  • Usa nombres de variables y métodos significativos.

  • Mantén las clases y métodos pequeños y enfocados en una sola responsabilidad.

  • Evita valores codificados; usa constantes o archivos de configuración en su lugar.

Pruebas

  • Escribe pruebas unitarias para todas las nuevas funcionalidades y correcciones de errores.

  • Asegúrate de que las pruebas existentes pasen antes de enviar un PR:

mvn test

  • Apunta a una alta cobertura de pruebas, pero prioriza pruebas significativas sobre una cobertura excesiva.

Documentación

Una buena documentación es clave para el éxito de Alba. Si mejoras o agregas documentación:

  • Actualiza el archivo README.md para información general.

  • Agrega o actualiza archivos .adoc para guías detalladas.

  • Asegúrate de que los ejemplos y fragmentos de código sean precisos y funcionales.

Licencia

Al contribuir a Alba, aceptas que tus contribuciones estarán bajo la [Licencia MIT](LICENSE).

¡Feliz codificación! 🚀