Los pull requests (PR) son la forma de enviar las modificaciones que propones a alguna parte de la base de código de Exercism.
Si estás leyendo esto y estás preparando un PR, ¡gracias!
Esta guía pretende ayudarte con la parte no técnica de los pull requests, para que tengas una gran experiencia y ayudes al mismo tiempo a nuestro equipo de mantenimiento.
Qué puedes esperar
El proceso de los pull requests es el siguiente:
- Envías un pull request.
- Una o varias personas del equipo de mantenimiento revisan el pull request y dejan comentarios con sugerencias.
En algunos casos, pueden comentar el pull request en conjunto para valorar si es lo adecuado que se añada.
- Tu pull request se fusiona y se te otorga Reputación en la web.
O tu pull request se cierra.
¿Cómo consigo que se fusione mi pull request?
Hay algunas cosas que puedes hacer de antemano para que sea más probable que tu pull request se fusione con cambios mínimos.
Lo más importante es asegurarte, antes de enviar el pull request, de que el equipo de mantenimiento verá con buenos ojos los cambios que propones.
La forma más sencilla de conseguirlo es abrir primero un issue en GitHub en el que expliques qué pretendes hacer y preguntes si el equipo de mantenimiento está abierto a esos cambios.
Si encuentras una tarea en la web de Exercism, no hace falta que abras un issue nuevo.
Puedes comentar en el issue existente que vas a trabajar en ella y ponerte manos a la obra.
Lo segundo es asegurarte de dejar una descripción clara en el pull request al abrirlo.
Los pull requests sin descripción son increíblemente frustrantes para el equipo de mantenimiento, ya que no tiene contexto al leer el código.
Cuéntanos por qué has hecho los cambios, enlaza el issue al que se refiere el pull request, explica los compromisos que hayas tenido que asumir, etc.
Por último, asegúrate de que tu pull request solo contenga cambios relacionados con una única mejora.
Si tienes varias mejoras, repártelas en varios pull requests.
Así el equipo de mantenimiento lo revisa de forma más fácil y rápida, y a ti también te resultará más fácil.
¿Cuánto tiempo debo esperar?
Normalmente, el equipo de mantenimiento revisará tu pull request en unos pocos días.
Durante la primera semana, por favor no añadas comentarios al pull request para reflotarlo: quienes mantenemos el proyecto somos personas voluntarias y muy ocupadas y lo revisaremos en cuanto podamos.
Si no has recibido respuesta en 7 días, etiqueta a @exercism/reviewers en un comentario nuevo del pull request y así avisarás a un equipo más amplio.
Gracias de nuevo por contribuir a Exercism.
¡Esperamos que sea una experiencia divertida y valiosa!
