Contribuir a ord

Pasos Sugeridos

  1. Encuentra un problema en el que quieras trabajar.
  2. Determina cuál debería ser el primer paso para abordar el problema. Esto podría involucrar código, investigación, la elaboración de una propuesta o incluso sugerir su cierre si está desactualizado o evaluar si es una buena idea desde un inicio.
  3. Comenta sobre el problema con un esquema de tu primer paso sugerido y pide opiniones. Podrías comenzar a escribir código o hacer pruebas de inmediato, pero esto evita que se haga un esfuerzo potencialmente desperdiciado.
  4. Si el problema requiere un cambio de código o corrección de bugs, abre un PR preliminar con pruebas y pide sugerencias. Esto asegura que todos estende acuerdo acerca de lo que se debe de hacer, o el primer paso en solucionar elproblema. Como se requieren pruebas escribirlas y probarlas confirma que se pueden llevar a cabo fácilmente.
  5. Escribe código hasta que las pruebas pasen y refactorizar hasta que el código esté listo para enviar.
  6. Marca el PR como listo para revisar.
  7. Revisa el PR según sea necesario.
  8. ¡Por último, fusiónalo!

Comienza por las cosas pequeñas

Los cambios pequeños te permitirán tener un impacto rápidamente, y si eliges el enfoque equivocado, no habrás perdido mucho tiempo.

Ideas para problemas pequeños:

  • Añadir una prueba nueva o un caso de prueba que amplíe la cobertura de las pruebas
  • Mejorar o añadir a la documentación existente
  • Identificar un problema que requiera más investigación, realizarla y resumir los hallazgos en un comentario
  • Encontrar un problema que ha quedado desactualizado y sugerir su cierre a través de un comentario
  • Encuentra un caso que no consideras un problema y proporciona tu opinión explicando por qué crees que ese el caso

Fusiona pronto y a menudo

Divide las tareas grandes en partes con las cuales se puede progresar por separado. Si hay un error, puedes abrir un PR que agregue una prueba fallida ignorada. Esto se puede fusionar, y el siguiente paso puede ser corregir el error y desactivar la prueba. Realiza investigaciones o pruebas y reporta tus resultados. Divide una característica en subcategorías pequeñas e impleméntalas una a la vez.

Descomponer un PR grande en PRs más pequeños que puedan fusionarse individualmente es un arte que vale la pena practicar. El desafío radica en asegurar que cada PR represente una mejora por sí mismo.

Me esfuerzo por aplicar este consejo yo mismo, y siempre obtengo beneficios cuando lo hago.

Los cambios pequeños son rápidos de escribir, revisar y fusionar, lo que es mucho más divertido que trabajar en un solo PR gigante que tarda una eternidad en escribirse, revisarse y fusionarse. Los cambios pequeños no toman mucho tiempo, así que, si necesitas dejar de trabajar en un cambio pequeño, no habrás perdido mucho tiempo a comparación de un cambio más grande en las que se invirtieron muchas horas de trabajo. Conseguir que un PR se fusione rápidamente mejora el proyecto de inmediato, en lugar de tener que esperar mucho tiempo para una mejora más grande. Los cambios pequeños tienen menos probabilidades de acumular conflictos de fusión. _Como decían los atenienses: Los rápidos hacen lo que quieren, los lentos hacen lo que deben.

Busca ayuda

Si te ves atascado por más de 15 minutos, busca ayuda en espacios como el Discord de Rust, en Stack Exchange, o en una discusión sobre el problema dentro del proyecto.

Practica la depuración basada en hipótesis

Formula una hipótesis sobre la causa del problema. Define cómo podrías verificar esa hipótesis. Ejecuta las pruebas correspondientes. Si funciona, genial, has solucionado el problema o, al menos, ahora sabes cómo hacerlo. Si no, vuelve a empezar con una nueva hipótesis.

Presta atención a los mensajes de error

Lee todos los mensajes de error y no toleres las advertencias.