Hytale Modding

Guías para Pull Request.

Pautas que los revisores y colaboradores deben seguir al enviar y revisar los Pull Request.

Guías para los Pull Request.

Para garantizar un proceso de revisión fluido y eficiente, tanto los colaboradores como los revisores deben seguir las siguientes directrices al enviar y revisar solicitudes de incorporación de cambios (PRs).

Para los contribuidores.

  1. Títulos y descripciones descriptivos.
    • Utiliza títulos claros y concisos que resuman los cambios.
    • Provee descripciones detalladas de lo que hace el PR, El porqué los cambios son necesarios y algún contexto relevante.
  2. Enlazar Incidencias
    • En el título de tu PR, añade `GH-ISSUE-NUMBER para vincular el PR con el problema correspondiente. Esto es obligatorio para todas las solicitudes de incorporación de cambios.
  3. Cambios pequeños enfocados
    • Procura que los PR sean pequeños y estén centrados en un único problema o funcionalidad. Esto facilita que los revisores entiendan y puedan dar feedback.
  4. Calidad del Código
    • Asegúrate de que tu código siga los estándares de codificación y buenas prácticas del proyecto.
    • Incluye comentarios cuando sea necesario para explicar lógica compleja.
  5. Prueba
    • Prueba tus cambios a fondo antes de enviar el PR.
    • Si aplica, incluye pruebas unitarias o pruebas de integración para verificar tus cambios.
  6. Documentación
    • Actualiza o añade la documentación necesaria para reflejar tus cambios.
  7. Mensajes de confirmación
  8. Comprobar Conflictos
    • Antes de enviar tu solicitud de incorporación de cambios, asegúrate de que tu rama esté actualizada con respecto a la rama base para minimizar conflictos de fusión.

Para Revisores

  • Debes revisar las solicitudes de incorporación de cambios de forma exhaustiva y solicitar cambios si es necesario.
  • Proporcionar comentarios constructivos y sugerencias de mejora.
  • Verifica que los cambios cumplen los estándares de codificación y mejores prácticas del proyecto.
  • Despliega el PR usando la integración de dokploy para asegurarte de que los cambios funcionan como se espera.
  • Asegúrate de que la documentación se actualice cuando sea necesario.
  • Aprueba las solicitudes de incorporación de cambios solo cuando estés satisfecho con los cambios y todas las comprobaciones se hayan superado.