Hay dos tipos de notas de mentoría:
- Notas específicas de un ejercicio (se muestran para un ejercicio concreto del track)
- Notas específicas de un track (se muestran para todos los ejercicios del track)
El objetivo de estas notas es:
- Hacer que mentorizar un ejercicio sea más fácil para los mentores
- Hacer que mentorizar un ejercicio sea consistente entre mentores
¿Qué contienen las notas de mentoría?
Las notas de mentoría específicas de un ejercicio suelen contener:
- Ejemplos de soluciones razonables
- Sugerencias y errores comunes
- Puntos de conversación
Las notas de mentoría específicas de un track suelen contener:
- Sugerencias y errores comunes (que se aplican a todos los ejercicios)
- Enlaces a recursos útiles (como una guía de estilo)
Cómo añadir notas de mentoría
Las notas de mentoría se guardan en el repositorio website-copy siguiendo estos patrones de nombres de archivo:
- Notas de mentoría de un ejercicio:
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- Notas de mentoría de un track:
tracks/<track-slug>/mentoring.md
Para añadir notas de mentoría, envía una PR que agregue un archivo siguiendo los patrones de nombres de archivo anteriores.
¿Por qué las notas de mentoría no están en el repositorio del track?
Mantener un track es bastante distinto de escribir notas de mentoría y requiere habilidades diferentes.
Por lo tanto, quienes escriben las notas de mentoría no tienen por qué ser necesariamente las mismas personas que mantienen un track.
Si guardáramos las notas de mentoría en el repositorio del track, los mantenedores tendrían que dar el visto bueno a cualquier PR de notas de mentoría antes de que se pudiera fusionar (o, como mínimo, se les notificaría cada cambio en las notas de mentoría).
Guardar las notas de mentoría en el repositorio website-copy nos permite:
- Reducir la carga de los mantenedores del track
- Que quienes revisen las notas de mentoría sean personas distintas de los mantenedores del track (eso sí, pueden coincidir)
- Permitir una iteración más rápida en las notas de mentoría (los mantenedores del track suelen ser bastante estrictos al fusionar PRs)
