¿Cómo añado o modifico mi perfil de profesor en Plan ₿ Network?

Si piensas contribuir a Plan ₿ Network escribiendo un nuevo tutorial o curso, necesitarás un perfil de profesor. Este perfil le permitirá recibir los créditos correspondientes por los contenidos que aporte a la plataforma.

Para aquellos de ustedes que ya han participado en la creación de contenidos educativos en Plan ₿ Network, probablemente ya tienen un perfil de profesor. Puedes encontrarlo en la carpeta /professors en nuestro repositorio de GitHub. Si tu perfil ya existe, encuentra tu nombre de usuario en el archivo professor.yml.

Para realizar cambios en su perfil, vaya a la sección «Editar su perfil de profesor» al final de este tutorial.

Añadir un nuevo profesor con nuestro software

La forma más sencilla de crear tu perfil de profesor en Plan ₿ Network es utilizar nuestra herramienta Python integrada. Así es como funciona.

1 – Configure su entorno local

Debe tener su propio Fork del repositorio Plan ₿ Network en GitHub.

Sincronice la rama principal (dev) de su Fork con el repositorio fuente.

Actualiza tu clon local.

# Cloner votre fork (si ce n'est pas déjà fait)
git clone https://github.com/<username>/bitcoin-educational-content.git
cd bitcoin-educational-content
# Ajouter le dépôt source en tant que remote upstream
git remote add upstream https://github.com/PlanB-Network/bitcoin-educational-content.git
# Récupérer les dernières modifications depuis le dépôt source
git fetch upstream
# Se positionner sur la branche principale 'dev'
git checkout dev
# Fusionner les modifications de la branche 'dev' du dépôt source dans votre fork
git merge upstream/dev
# Pousser les mises à jour vers votre fork sur GitHub
git push origin dev

2 – Crear una nueva sucursal

Asegúrate de que estás en la rama dev. Crea una nueva rama con un nombre descriptivo (por ejemplo, add-professor-loic-morel).

Publique esta rama en su Fork en línea.

# Assurez-vous d’être sur la branche 'dev'
git checkout dev
# Créez une nouvelle branche avec un nom descriptif
git checkout -b add-professor-loic-morel
# Publiez cette branche sur votre fork en ligne
git push -u origin add-professor-loic-morel

3 – Cree su perfil de profesor

Ve a la carpeta scripts/tutorial-related/data-creator/ en tu clon local. Asegúrate de haber instalado todas las dependencias necesarias para el software, habiendo instalado primero Python:

pip install -r requirements.txt

A continuación, inicie el software con el comando:

python3 main.py

Una vez en la página de inicio, introduce la ruta local al clon de tu repositorio, el idioma en el que estás escribiendo y tu ID de GitHub. Si estás creando este perfil para otra persona y ya tienes un perfil de Profesor, introduce tu ID en el campo «PBN Professor’s ID«. Si estás creando tu propio perfil, aún no tendrás un ID de Profesor, ya que estás en proceso de crear uno, así que deja este campo en blanco.

A continuación, haga clic en el botón «Nuevo profesor«.

Rellene la información requerida (tenga en cuenta que toda esta información será pública tanto en nuestra plataforma como en GitHub):

• Nombre de su expediente de profesor (utilice su nombre y apellidos o un seudónimo, en minúsculas) ;
• Su nombre o apodo ;
• Su sitio web y perfil X (opcional) ;
• Un Address relámpago para recibir donativos de los lectores (opcional) ;
• Seleccione 2 o 3 etiquetas de la lista;
• Haga clic en «Seleccionar imagen» para elegir una imagen de perfil de sus carpetas locales (puede utilizar cualquier nombre y formato para la imagen, y el software la adaptará automáticamente. Sólo asegúrate de que la imagen sea cuadrada);
• Escriba una breve descripción de su perfil.

Finalice la creación haciendo clic en «Crear Profesor«. Esto automáticamente generate todos los archivos necesarios para su perfil.

Guarda tus cambios localmente creando un commit con un mensaje explicativo. Empuje los cambios a su Fork GitHub.

# Créez un commit avec un message descriptif
git commit -m "*new professor Loïc Morel*"
# Poussez vos modifications sur votre fork
git push origin add-professor-loic-morel

Una vez terminado, crea una Pull Request (PR) en GitHub para proponer la integración de tus modificaciones. Añade un título y una breve descripción al PR.

4 – Corrección y fusión

Espere la validación o los comentarios de un administrador. Si es necesario, haga correcciones y envíe nuevos commits.

# Créez un commit décrivant les corrections apportées
git commit -m "*Corrections suite à la revue du tutoriel green-wallet*"
# Poussez les corrections sur votre fork
git push origin add-professor-loic-morel

Una vez fusionado el PR, puede eliminar su rama de trabajo.

Modificar su perfil de profesor

Si ya dominas el uso de Git, modifica tu perfil de profesor creando una nueva rama y editando el archivo correspondiente directamente en la carpeta existente. Los cambios pueden realizarse en el archivo professor.yml o en el archivo markdown, en función de la información que deba corregirse. Una vez que hayas hecho los cambios localmente, envíalos a tu Fork y envía un PR.

Para los principiantes, recomiendo hacer la modificación directamente a través de la web Interface de GitHub. Asegúrate de tener una cuenta en GitHub. Si no sabes cómo crear una, sigue este tutorial:

https://planb.network/tutorials/contribution/others/create-github-account-a75fc39d-f0d0-44dc-9cd5-cd94aee0c07c
Vaya a el repositorio GitHub de Plan ₿ Network dedicado a los datos.

Haga clic en la carpeta «profesores» y, a continuación, vaya a su carpeta personal.

Para cambiar los metadatos de su perfil, como Lightning Address, el nombre o los enlaces, seleccione el archivo «professor.yml«. Para cambiar su descripción, haga clic en el archivo YAML correspondiente a su idioma (por ejemplo, «en.yml» o «fr.yml«).

Si modifica su descripción, recuerde eliminar todas las traducciones obsoletas. Entonces puedes encargarte de traducir tu descripción a los otros idiomas con la ayuda de un LLM, o dejar solo la descripción en tu idioma nativo y mencionar en tu Pull Request que tu descripción requiere traducción por parte de nuestro equipo.

Una vez sobre el fichero que desea modificar, pulse sobre el icono del lápiz.

Si aún no tienes un Fork del repositorio Plan ₿ Network, GitHub te sugerirá que crees uno. Haz clic en «Fork este repositorio«.

Realice los cambios deseados en el archivo. Cuando haya terminado, haga clic en «Commitir cambios«.

Introduzca un mensaje que describa su cambio y, a continuación, seleccione «Proponer cambios«.

Aparecerá un resumen de sus cambios. Si desea realizar más cambios en su perfil, puede volver a las carpetas y realizar más commits. Cuando haya terminado, haga clic en «Crear pull request«.

Una Pull Request es una solicitud hecha para integrar cambios de su rama en la rama principal del repositorio Plan ₿ Network, permitiendo la revisión y discusión de los cambios antes de que sean fusionados.

Asegúrate, en la parte superior de Interface, de que tu rama de trabajo está fusionada con la rama dev del repositorio Plan ₿ Network (que es la rama principal).

Introduzca un título que resuma brevemente los cambios que desea fusionar con el repositorio fuente. Añada un breve comentario que describa estos cambios y, a continuación, haga clic en el botón Green «Crear pull request» para confirmar la pull request:

Su PR será visible en la pestaña «Pull Request» del repositorio principal de Plan ₿ Network. Todo lo que tienes que hacer ahora es esperar a que un administrador fusione tu modificación.

Si encuentras alguna dificultad técnica al enviar tu cambio, no dudes en pedir ayuda en nuestro grupo de Telegram dedicado a las contribuciones. Muchas gracias