Existen 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 dar mentoría a un ejercicio sea más fácil para los mentores
- Hacer que dar mentoría a 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 trampas comunes
- Puntos de conversación
Las notas de mentoría específicas de un track suelen contener:
- Sugerencias y trampas comunes (que aplican a todos los ejercicios)
- Enlaces a recursos útiles (como una guía de estilo)
Cómo agregar notas de mentoría
Las notas de mentoría se guardan en el repositorio website-copy usando los siguientes 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 agregar notas de mentoría, envía un PR que agregue un archivo que siga 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 diferente de escribir notas de mentoría y requiere habilidades distintas.
Por lo tanto, quienes escriben notas de mentoría no tienen por qué ser las mismas personas que mantienen un track.
Si guardáramos las notas de mentoría dentro del repositorio del track, los mantenedores tendrían que aprobar cualquier PR de notas de mentoría antes de que se pueda fusionar (o al menos recibirían una notificación por cada cambio en las notas de mentoría).
Guardar las notas de mentoría en el repositorio website-copy nos permite:
- Reducir la carga para los mantenedores del track
- Que las notas de mentoría las revise gente distinta de los mantenedores del track (pueden ser las mismas personas)
- Iterar más rápido en las notas de mentoría (los mantenedores del track suelen ser bastante estrictos al fusionar PRs)
