Esistono due tipi di note di mentoring:
- Note specifiche di un esercizio (mostrate per un esercizio specifico del track)
- Note specifiche di un track (mostrate per tutti gli esercizi del track)
L'obiettivo di queste note è:
- Rendere più facile il mentoring di un esercizio per i mentori
- Rendere il mentoring di un esercizio coerente tra i mentori
Cosa contengono le note di mentoring?
Le note di mentoring specifiche di un esercizio contengono spesso:
- Esempi di soluzioni ragionevoli
- Suggerimenti/insidie comuni
- Punti di discussione
Le note di mentoring specifiche di un track contengono spesso:
- Suggerimenti/insidie comuni (che valgono per tutti gli esercizi)
- Link a risorse utili (come una guida di stile)
Come aggiungere le note di mentoring
Le note di mentoring sono archiviate nel repo website-copy seguendo questi schemi di denominazione dei file:
- Note di mentoring di un esercizio:
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- Note di mentoring di un track:
tracks/<track-slug>/mentoring.md
Per aggiungere note di mentoring, invia una PR che aggiunge un file secondo gli schemi di denominazione dei file qui sopra.
Perché le note di mentoring non sono nel repo del track?
Gestire un track è molto diverso dallo scrivere note di mentoring e richiede competenze diverse.
Perciò, le persone che scrivono le note di mentoring non devono per forza essere le stesse che gestiscono un track.
Se conservassimo le note di mentoring nel repo del track, i maintainer dovrebbero approvare ogni PR sulle note di mentoring prima che possa essere unita (o almeno verrebbero avvisati per ogni modifica alle note di mentoring).
Conservare le note di mentoring nel repo website-copy ci permette di:
- Ridurre il carico sui maintainer dei track
- Avere anche persone diverse dai maintainer dei track che revisionano le note di mentoring (possono anche sovrapporsi)
- Permettere un'iterazione più rapida sulle note di mentoring (i maintainer dei track sono spesso piuttosto severi quando uniscono le PR)
