¡Gracias por tu interés en contribuir a la API de la Kings League! Apreciamos cualquier ayuda, grande o pequeña y estamos agradecidos por tu tiempo y esfuerzo. Este documento establece las pautas para contribuir al proyecto, así como el proceso para enviar pull requests.
Hay muchas formas en las que puedes contribuir a la API de la Kings League, incluyendo:
- Informar de buges y enviar solicitudes de nuevas funciones.
- Escribir documentación.
- Mejorar la cobertura de pruebas del código.
- Enviar cambios de código y correcciones de buges.
Antes de enviar una pull request, asegúrate de hacer lo siguiente:
- Confirma que tu código siga la guía de estilo del proyecto.
- Escribe pruebas para cualquier código nuevo que hayas agregado.
- Certifica que todas las pruebas pasen.
- Actualiza la documentación para reflejar cualquier cambio (recomendado).
- Forkea el repositorio y crea una nueva rama para tus cambios.
- Realiza los cambios necesarios y haz commit de tu código con un mensaje de commit claro.
- Empuja tus cambios a tu fork.
- Envía una pull request al repositorio principal.
- Los dueños del repositorio revisarán tu pull request y pueden solicitar cambios o mejoras.
- Una vez que se hayan realizado los cambios y se haya aprobado la pull request, se fusionará en la rama principal.
Al escribir mensajes de commit, sigue estas buenas prácticas:
-
Usa el modo imperativo en tu mensaje de commit. Por ejemplo, "Arreglar bug" en lugar de "bug arreglado" o "Arreglos de bug".
-
Evita usar puntos de exclamación o signos de interrogación en tu mensaje de commit.
-
Mantén tu mensaje de commit corto y conciso, idealmente no más de 50 caracteres.
-
Usa el cuerpo del mensaje de commit para proporcionar cualquier contexto o detalles necesarios sobre el commit.
-
Utiliza prefijos en tus mensajes de commit para hacerlos más semánticos. Algunos prefijos comunes incluyen:
"feat"para nuevas funcionalidades."fix"para correcciones de buges."perf"para mejoras de rendimiento."build"para cambios en el sistema de construcción."ci"para cambios en la integración continua."docs"para cambios en la documentación."refactor"para cambios de refactorización."style"para cambios de formato."test"para cambios en las pruebas.
Para obtener más información sobre cómo escribir buenos mensajes de commit, puedes consultar este artículo.
Si has encontrado un bug en la API de la Kings League, te agradeceríamos que nos informaras. Para informar de un bug, sigue estos pasos:
- Revisa las issues existentes en el repositorio para ver si el bug ya ha sido reportado. Si es así, puedes agregar información adicional a la issue existente.
- Si el bug no ha sido reportado, crea una nueva issue y proporciona una descripción clara y concisa del problema.
- Incluye cualquier detalle relevante, como la versión de la API que estás utilizando, la plataforma que estás utilizando (por ejemplo, Windows, Mac, Linux) y los pasos para reproducir el bug.
- Si es posible, incluye cualquier mensaje de bug o registros que puedan ser relevantes para el problema.
Si eres nuevo en estas tecnologías, no te preocupes, tenemos una gran comunidad de desarrolladores en Discord, siempre dispuestos a ayudar y responder a cualquier pregunta que tengas.