Il existe deux types de notes de mentorat :
- Les notes spécifiques à un exercice (affichées pour un exercice précis du parcours)
- Les notes spécifiques à un parcours (affichées pour tous les exercices du parcours)
Ces notes ont pour but de :
- Faciliter le mentorat d'un exercice pour les mentors
- Rendre le mentorat d'un exercice cohérent d'un mentor à l'autre
Que contiennent les notes de mentorat ?
Les notes de mentorat spécifiques à un exercice contiennent souvent :
- Des exemples de solutions raisonnables
- Des suggestions et des pièges fréquents
- Des points de discussion
Les notes de mentorat spécifiques à un parcours contiennent souvent :
- Des suggestions et des pièges fréquents (qui s'appliquent à tous les exercices)
- Des liens vers des ressources utiles (comme un guide de style)
Les notes de mentorat sont stockées dans le dépôt website-copy, selon les conventions de nommage de fichiers suivantes :
- Notes de mentorat pour un exercice :
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- Notes de mentorat pour un parcours :
tracks/<track-slug>/mentoring.md
Pour ajouter des notes de mentorat, soumets une PR qui ajoute un fichier en respectant les conventions de nommage ci-dessus.
Pourquoi les notes de mentorat ne sont-elles pas dans le dépôt du parcours ?
Maintenir un parcours est très différent de la rédaction de notes de mentorat et demande des compétences différentes.
Par conséquent, les personnes qui rédigent les notes de mentorat ne sont pas forcément les mêmes que celles qui maintiennent un parcours.
Si l'on stockait les notes de mentorat dans le dépôt du parcours, les mainteneurs devraient approuver chaque PR de notes de mentorat avant qu'elle puisse être fusionnée (ou du moins être notifiés à chaque modification des notes de mentorat).
Stocker les notes de mentorat dans le dépôt website-copy permet de :
- Réduire la charge qui pèse sur les mainteneurs de parcours
- Faire relire les notes de mentorat par des personnes différentes des mainteneurs du parcours (les deux peuvent se recouper)
- Permettre des itérations plus rapides sur les notes de mentorat (les mainteneurs de parcours se montrent souvent assez stricts lors de la fusion des PR)
