Guía de pull requests para colaboradores


¡Gracias por querer contribuir a Exercism! Antes de crear un pull request, lee la guía cómo hacer un buen pull request, que pretende ayudarte con la parte no técnica de los pull requests para que tengas una buena experiencia y ayudes al mismo tiempo a nuestro equipo de maintainers.

Este documento contiene algunas directrices adicionales, específicas de Exercism, para distintos tipos de pull requests.

Pull requests de ejercicios

Crear un pull request para un ejercicio de concepto o un ejercicio de práctica puede resultar intimidante por la gran cantidad de reglas que rodean este tipo de ejercicios. Por este motivo, una revisión puede llevar a un maintainer de dos a tres horas y dar lugar a docenas de comentarios.
Para ayudarte, habrá un revisor principal que comentará tu pull request.

No te desanimes por la cantidad de comentarios de revisión; es totalmente normal que un ejercicio pase por varias reescrituras antes de llegar a algo que satisfaga tanto a ti como al revisor principal.

Recomendaciones

Aquí tienes algunas recomendaciones para ayudarte a agilizar aún más el proceso.

Lee la documentación

Antes de crear un pull request para un ejercicio, asegúrate de leer la documentación de los ejercicios de concepto o la de los ejercicios de práctica. Leer la documentación de antemano ayuda enormemente, ya que las revisiones tendrán menos comentarios y tu pull request se fusionará mucho antes.

Examina los ejercicios existentes (si los hay)

Si el track tiene algún ejercicio existente, dedica un tiempo a estudiarlos un poco para ver cómo son y cómo están estructurados.

Pull requests de ejercicios de práctica

Piensa si el cambio corresponde realmente a problems-specifications

Parte del contenido de un ejercicio de práctica (como su introducción) proviene de sus metadatos (compartidos) tal como se definen en el repositorio problems-specifications. Si tienes intención de actualizar ese contenido, piensa si el cambio podría beneficiar también a otros tracks. Si es así, abre un pull request a los metadatos del ejercicio en el repositorio problems-specifications en su lugar.

Recomendaciones generales

Evita hacer revisiones no solicitadas

Todas las revisiones de pull requests las realiza uno (o varios) maintainers del track, ya que son los responsables de aprobar todos los cambios del repositorio. Que sean los maintainers quienes hagan la revisión también ayuda a evitar comentarios contradictorios para quien crea el pull request.

Por supuesto, eres libre de dejar un comentario para ofrecer ayuda con la revisión (sobre todo en pull requests grandes) o plantear preguntas si detectas algo que parece un error.