Proporcionar una revisión de solicitud de extracción¶
Todo el mundo es bienvenido a revisar cualquier contribución al proyecto BeeWare. Hay algunas consideraciones importantes que conviene tener en cuenta antes de empezar.
PIENSE antes de revisar¶
Antes de emprender una revisión, PIENSE. Como revisores, consideraríamos si la respuesta que vamos a enviar es:
- Cierto. Esfuércese siempre por ofrecer sugerencias e información precisas.
- Útil. Estamos proporcionando orientación sobre cómo mejorar la presentación; esta orientación debe identificar claramente la fuente de un problema o un caso de uso no considerado, e idealmente proporciona una ruta a seguir para lo que resolvería o satisfaría el cometido.
- Inspirar. Depende de nosotros inspirar al autor para que quiera realizar los cambios que le pedimos.
- Necesario. Se espera que el autor lea todo lo que publicamos; debemos respetar su tiempo y esfuerzo publicando sólo cuando sea necesario.
- Amable. Hay muchas formas de presentar el mismo comentario; necesitamos asegurarnos que elegimos ser amables, comprensivas y constructivos con nuestras palabras.
Es perfectamente posible PENSAR y, al mismo tiempo, realizar una crítica eficaz. Los conceptos expuestos anteriormente no excluyen la posibilidad de señalar cualquier incidencia que encuentre en un RP. Los colaboradores no tendrán la oportunidad de mejorar su contribución si no son conscientes de las áreas que necesitan mejoras. Lo importante es ser consciente de cómo se presenta esta retroalimentación. Intenta despersonalizar tu crítica. En lugar de: “Has cometido una equivocación,” puedes decir: “Este código podría mejorarse”. Revisa el código, no al autor.
Es importante recordar que, además de identificar las áreas que necesitan mejoras, hay que hacer comentarios positivos. Si, por ejemplo, los cambios son especialmente útiles, hacen algo particularmente inteligente o te presentan un API que no conocías, ¡házselo saber al autor! Nunca subestimes el efecto de señalar algo que alguien ha hecho correctamente o bien, en medio de una situación en la que todo lo demás que has señalado son incidencias que hay que resolver.
Sugerencias de revisión en GitHub¶
La interfaz de revisión de GitHub tiene un mecanismo para sugerencias de cambios, en el que puedes proporcionar el cambio exacto que estás sugiriendo como reemplazo del contenido existente. Tenga en cuenta que, hasta que sean aceptados y confirmados, estos cambios sugeridos no se someterán a comprobaciones previas a la confirmación ni a las comprobaciones de linting. Por lo tanto, esta prestación debe utilizarse para cambios pequeños, ya que cuanto mayor sea el cambio sugerido, más probable es que introduzca incidencias.