Es gibt zwei Arten von Mentoring-Notizen:
- Übungsspezifische Notizen (werden für eine bestimmte Übung im Track angezeigt)
- Trackspezifische Notizen (werden für alle Übungen im Track angezeigt)
Das Ziel dieser Notizen ist es:
- Das Mentoring einer Übung für Mentoren einfacher zu machen
- Das Mentoring einer Übung über alle Mentoren hinweg einheitlich zu machen
Was enthalten Mentoring-Notizen?
Übungsspezifische Mentoring-Notizen enthalten oft:
- Beispiele für sinnvolle Lösungen
- Häufige Anregungen/Stolperfallen
- Gesprächsthemen
Trackspezifische Mentoring-Notizen enthalten oft:
- Häufige Anregungen/Stolperfallen (die für alle Übungen gelten)
- Links zu nützlichen Ressourcen (wie einem Styleguide)
Wie du Mentoring-Notizen hinzufügst
Mentoring-Notizen werden im website-copy-Repo gespeichert, und zwar nach folgenden Dateinamensmustern:
- Mentoring-Notizen für Übungen:
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- Mentoring-Notizen für Tracks:
tracks/<track-slug>/mentoring.md
Um Mentoring-Notizen hinzuzufügen, reiche einen PR ein, der eine Datei nach dem obigen Dateinamensmuster hinzufügt.
Warum stehen die Mentoring-Notizen nicht im Track-Repo?
Einen Track zu pflegen ist etwas ganz anderes, als Mentoring-Notizen zu schreiben, und erfordert andere Fähigkeiten. Deshalb sollten die Personen, die Mentoring-Notizen schreiben, nicht unbedingt dieselben sein, die einen Track pflegen.
Wenn wir die Mentoring-Notizen im Repo des Tracks speichern würden, müssten Maintainer jeden PR zu Mentoring-Notizen absegnen, bevor er gemergt werden kann (oder sie würden zumindest bei jeder Änderung an einer Mentoring-Notiz benachrichtigt). Die Mentoring-Notizen im website-copy-Repo zu speichern ermöglicht es uns:
- die Last für die Track-Maintainer zu verringern
- auch andere Personen als die Track-Maintainer die Mentoring-Notizen prüfen zu lassen (sie können sich überschneiden)
- schneller an Mentoring-Notizen zu iterieren (Track-Maintainer sind beim Mergen von PRs oft recht streng)
