Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 4.42 KB

contributing.md

File metadata and controls

82 lines (53 loc) · 4.42 KB

Contribuciones

Me encanta trabajar en equipo y creo que el resultado es mucho mejor cuando trabajas con más gente. Por este motivo he decidido desarrollar estás herramientas como código abierto para compartirlas con la comunidad y que esta me ayude a mejorarlas.

Si quieres usar y compartir estás herramientas, te convertirás en un miembro más del equipo. El código abierto se trata de compartir y contribuir.

Me alegra mucho que utilices estas herramientas, pero me gustaría más si contribuyes en ellas de alguna manera (compartirlas, solucionar problemas, agregar funcionalidad nueva, etc).

Para hacerlo, solo hay algunas pautas a seguir para mantener el código limpio y organizado.

Puedes contribuir mediante:

Compartiendo en redes sociales ❤️

Comparte tu opinión acerca de mi trabajo, positiva o negativa (intenta ser constructivo...).

Ten en cuenta que proporciono estas herramientas de forma gratuita. Suelo ver muchos comentarios negativos sobre algunos proyectos de código abierto en las redes sociales... Creo que es mucho mejor hacer algo malo y compartirlo, que criticar mientras no se hace nada.

Remitiendo errores

Esta es la contribución más sencilla que puedes hacer a un proyecto. Solo te recomiendo seguir algunas pautas para que resulte más fácil solucionarlos:

Describe el problema Versiones (herramienta, entorno, etc ...) Cómo reproducir el problema Mensajes de error, etc ... Sigue el hilo del problema que has creado, por si tengo alguna duda o puedo ofrecerte una solución

Solucionando errores

Solucionarlo es mucho mejor que simplemente indicarlo ...

Solucionar errores es la mejor forma de comenzar a contribuir en un proyecto de código abierto. Ya sea solucionando un error que te haya ocurrido a ti, o un error que haya ocurrido a otra persona es la mejor manera de entender como funciona la herramienta y echar un vistazo bajo el capó. ¡Estaré encantado de añadirte como colaborador! Las pautas serían:

  1. Comenta en el hilo del error que puedes arreglarlo, evitaremos que hayan varias personas arreglando el mismo error

  2. Haz un fork del proyecto

  3. Crea una rama y nombrala issue/{issueId}

  4. Soluciona el error

  5. Realiza test

    5.1. Ejecuta los test actuales y comprueba que todo lo demás sigue funcionando 5.2. Añade nuevos test para garantizar que la solución siga funcionando a lo largo del tiempo

  6. Realiza un pull-request, y trata de explicar brevemente como has solucionado el problema.

  7. Espera hasta que recibas una contestación.

No te enfades si a veces, tu solución, no se fusiona con el proyecto. Esto no significa que no te lo agradezca, puede que otra persona ya lo haya realizado o que la solución no se ajusta al estándar del proyecto. Recuerda que siempre estaré agradecido de que contribuyas de cualquier manera posible...

Añadiendo nueva funcionalidad

Añadir nuevas funcionalidades es otra gran manera de contribuir a un proyecto. Esto hace que las herramientas sean cada vez mejores. Los pasos serían:

  1. Crear un "issue" con la etiqueta "enhancement" (mejora)

  2. Comenta tu idea antes de ponerte a programar como un loco 2.1. Espera a que el desarrollador oficial confirme tu idea 2.2. Esto pretende evitar que el proyecto crezca sin control

  3. Realiza un Fork del proyecto

  4. Crear una rama llamada feature/{issueId}

  5. Desarrolla la nueva funcionalidad

  6. Realiza test de la nueva funcionalidad

    6.1. Ejecuta los test actuales y comprueba que todo lo demás sigue funcionando 6.2. Añade nuevos test para garantizar que la nueva funcionalidad siga funcionando a lo largo del tiempo

  7. Documenta la nueva funcionalidad, para que otros puedan utilizarla.

  8. Realiza un pull-request.

  9. Espera hasta que recibas una contestación.

Conviértete en un colaborador oficial

Lo que más me gustaría es que quisieras ayudarme a mantener e impulsar Didor hacia adelante:

  1. Contribuye al proyecto al menos un par de veces

  2. Envíame un email a fvena32@gmail.com, y dedica algunas lineas a:

    2.1 Explicar porque te gustaría participar en el proyecto 2.2 Tu nombre de usuario en Github 2.3 Cualquier otra cosa que consideres oportuna

Haciendo una pequeña donación

Como todos los proyectos de código abierto, el desarrollador trabaja para brindarle las mejores herramientas posibles. Puedes mostrar tu gratitud mandando un simple email a fvena32@gmail.com, o haciendo una pequeña donación (también se aceptan donaciones grandes) mediante paypal(proximamente).