Cómo participar en la revisión de contenidos educativos en Plan ₿ Network?
En resumen
Si quieres participar en la revisión y corrección de contenidos para Plan ₿ Network, únete a nuestro grupo de Telegram dedicado a las contribuciones. Preséntate brevemente, luego especifica el contenido que te gustaría revisar y el idioma. Realiza tus correcciones en una rama de trabajo y envía un PR una vez finalizada tu revisión.
Si no has entendido la parte de arriba, no te preocupes: ¡este tutorial es para ti!
¿Qué es Plan ₿ Network?
Plan ₿ Network es una plataforma para aprender sobre Bitcoin a través de numerosos cursos y tutoriales para todos. Actualmente, todo nuestro contenido es de código abierto, alojado en un repositorio de GitHub y está abierto a contribuciones para revisión y creación de contenido.
Plan ₿ Network tiene como objetivo convertirse en la plaza pública del ciberespacio de Bitcoin, conectando y fomentando comunidades de Bitcoin en todo el mundo.
¿Por qué contribuir?
Plan ₿ Network es fundamentalmente multilingüe, ya que nuestro objetivo es hacer que los recursos de Bitcoin sean accesibles a todo el mundo. Creemos que el idioma no debería ser una barrera para el dinero soberano.
Para lograr esto, utilizamos un enfoque Humano x IA. A través de nuestro programa, podemos traducir automáticamente nuestros contenidos a muchos idiomas. Sin embargo, necesitamos un hablante fluido que lo revise para asegurar que el contenido sea comprensible y esté libre de términos inapropiados.
Si quieres ayudar a construir este proyecto educativo para promover la educación sobre Bitcoin en tu comunidad, puedes empezar revisando un curso o tutorial.
Además, como apreciamos el modelo Valor por Valor, recompensaremos las contribuciones de revisión. La recompensa se basará en la longitud del contenido, la precisión lingüística de nuestra traducción automática y la dificultad del contenido.
¿Necesito saber cómo funciona GitHub?
No necesitas ser un experto en GitHub para revisar contenidos. Aunque siempre es mejor entender lo que estás haciendo (y por qué), puedes simplemente seguir las siguientes instrucciones para contribuir.
Sin embargo, si no estás familiarizado con Git y GitHub y quieres aprender más, puedes consultar nuestro artículo introductorio sobre estas herramientas:
1. Crear una cuenta
- Crea una cuenta en GitHub para empezar a contribuir. Si necesitas orientación para crear tu cuenta de GitHub, también tenemos un tutorial detallado:
- También necesitarás una cuenta en la aplicación de mensajería Telegram.
2. Únete al grupo de Telegram
- Únete al grupo PBN Content Builder en Telegram.
- Preséntate brevemente y especifica el contenido al que deseas contribuir y el idioma en un mensaje en el canal «General».
- Un miembro del equipo creará entonces un issue (incidencia) en GitHub para tu futura contribución. Encontrarás toda la información necesaria para iniciar tu revisión allí.
3. Revisa y edita el contenido a través de la interfaz de GitHub
- El issue contiene una descripción (ver *A*) con enlaces al contenido original y al archivo que hay que revisar.
- Si deseas encargarte de la revisión, deja un comentario en el issue (ver *B*) para indicar que trabajarás en él. Esto evita esfuerzos duplicados.
- Haz clic en el enlace situado junto al archivo que deseas revisar (ver *C*) para acceder al contenido.
- Ahora puedes ver la interfaz de GitHub del archivo a revisar.
- El panel izquierdo te permite navegar por tu rama (ver *A*) y ficheros (ver *B*).
- Haz clic en el icono del lápiz para iniciar la revisión (ver *C*).
- Si es tu primera contribución, GitHub te pedirá que hagas un fork (bifurcación) del repositorio fuente. Haz clic en el botón.
- Luego llegarás a la interfaz del Editor (ver *A*), donde puedes ver la ruta del archivo y la rama correspondiente (ver *B*) y cambiar entre los modos de edición y vista previa (ver *C*).
Nota: Se recomienda revisar en la ventana de código, con el contenido original en una ventana separada. Por ejemplo, puedes ver el texto en el sitio web de Plan ₿ Network o en la vista previa de GitHub en una pestaña del navegador. Utiliza ctrl + F para localizar errores y hacer correcciones en la vista de código a medida que avanzas.
4. Comprometer cambios
- Puedes empezar a revisar y corregir el contenido según sea necesario.
- Cuando quieras pausar tu sesión, puedes confirmar tus cambios, incluso si la revisión no ha terminado. Es como guardar tu progreso en GitHub.
- Haga clic en el botón «Commit Changes…» (Confirmar cambios).
- Añade un mensaje descriptivo para tus cambios (ver *A*).
- Agrega más contexto en la descripción si es necesario (ver *B*).
- Haga clic en el botón «Propose changes» (Proponer cambios) (ver *C*).
- Si esta no es tu primera contribución, GitHub te pedirá que crees una nueva rama. Nunca debes confirmar directamente en la rama principal
dev. Si ya has hecho commits en una rama de trabajo existente, selecciona esa rama. De lo contrario, elige la opción «Create a new branch» (Crear una nueva rama) para crear una nueva.
- Accederás entonces a una página que resume todos tus cambios. Al desplazarte por ella, podrás ver las modificaciones precisas: los elementos eliminados aparecen en rojo, mientras que los añadidos aparecen en verde.
- Si no has terminado tu revisión y deseas continuar más tarde, puede simplemente salir.
- Siempre que hayas confirmado tus cambios, se guardarán en tu fork de GitHub.
- Para reanudar tu trabajo, ve a tu fork del repositorio de contenidos Plan ₿ Network a través de tu perfil de GitHub.
- Selecciona la rama que contiene tu progreso (ver *A*), localiza tu archivo de contenido (ver *B*) y haz clic en el icono del lápiz para continuar la revisión.
5. Crear un PR con la rama dedicada
- Si todo se ve bien y has terminado tus cambios, haz clic en el botón verde «Crete Pull Request» (Crear Pull Request).
- Entonces llegarás a la página PR. Un Pull Request es una solicitud para enviar los cambios realizados en una rama de un repositorio remoto para su revisión y posible fusión en la rama principal.
- Agrega un título y una breve descripción a tu RP. El título debe coincidir con el issue en el que estás trabajando. Por ejemplo, si el título del issue es
[TRADUCCIÓN] Curso CYP201 - FR, utiliza el mismo título para tu RP (ver *A*). En la descripción, menciona el issue asociado utilizando su número, precedido por «Closes» (Cierra). Esto cerrará automáticamente el issue una vez que se haya fusionado el PR (ver *B*). - Si todo parece correcto, haz clic en el botón verde «Create Pull Request» (ver. *C*).
6. Reglas a seguir al corregir contenido
Para obtener más información sobre las pautas a seguir al corregir en Plan ₿ Network en términos de reglas de lenguaje o formato, consulte el tutorial «contribution-proofreading-guidelines» en esta misma sección.
7. Espera la revisión
- ¡Felicidades, tu PR ha sido enviado! Puedes seguir su progreso en la pestaña «Pull requests» del repositorio GitHub de Plan ₿ Network:
- ¡Muchas gracias por tu contribución! Tras la aprobación, un miembro del equipo de Plan ₿ Network se pondrá en contacto contigo para enviarte tu recompensa. *Los pagos se realizan exclusivamente a través de Lightning Network*.
- Si quieres empezar de nuevo, vuelve al paso 2 y envía un nuevo mensaje en el grupo de Telegram para seguir contribuyendo a otros contenidos. Asegúrate de sincronizar tu fork antes de crear una nueva rama de trabajo. Para ello, ve a la página de inicio de tu fork, selecciona la rama principal llamada
dev(ver *A*), y luego haz clic en el botón «Sync fork» (Sincronizar bifurcación) (ver *B*). Si hay actualizaciones disponibles para tu fork, aparecerá un botón «Update branch» (Actualizar rama). Simplemente haga clic en él para realizar la actualización.
- Si tienes alguna observación, pregunta o comentario sobre este proyecto, no dudes en enviar un DM al grupo de Telegram de los colaboradores.
