मेंटर नोट्स दो तरह के होते हैं:
- अभ्यास-विशेष नोट्स (ट्रैक के किसी एक खास अभ्यास के लिए दिखाए जाते हैं)
- ट्रैक-विशेष नोट्स (ट्रैक के सभी अभ्यासों के लिए दिखाए जाते हैं)
इन नोट्स का उद्देश्य है:
- मेंटर के लिए किसी अभ्यास का मेंटर करना आसान बनाना
- सभी मेंटर के बीच किसी अभ्यास का मेंटर करना एक जैसा बनाना
मेंटर नोट्स में क्या होता है?
अभ्यास-विशेष मेंटर नोट्स में अक्सर ये चीज़ें होती हैं:
- उचित हल के उदाहरण
- आम सुझाव/गलतियाँ
- चर्चा के बिंदु
ट्रैक-विशेष मेंटर नोट्स में अक्सर ये चीज़ें होती हैं:
- आम सुझाव/गलतियाँ (जो सभी अभ्यासों पर लागू हैं)
- उपयोगी संसाधनों के लिंक (जैसे स्टाइल गाइड)
मेंटर नोट्स कैसे जोड़ें
मेंटर नोट्स website-copy रेपो में इन फाइल नाम पैटर्न के अनुसार रखे जाते हैं:
- अभ्यास के मेंटर नोट्स:
tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md
- ट्रैक के मेंटर नोट्स:
tracks/<track-slug>/mentoring.md
मेंटर नोट्स जोड़ने के लिए ऊपर दिए गए फाइल नाम पैटर्न के अनुसार एक फाइल जोड़कर PR भेजिए।
मेंटर नोट्स ट्रैक रेपो में क्यों नहीं रखे जाते?
ट्रैक को बनाए रखना, मेंटर नोट्स लिखने से काफी अलग काम है और इसके लिए अलग कौशल चाहिए।
इसलिए ज़रूरी नहीं कि मेंटर नोट्स लिखने वाले लोग वही हों जो ट्रैक बनाए रखते हैं।
अगर हम मेंटर नोट्स ट्रैक के रेपो में रखते, तो मेंटेनर को मेंटर नोट से जुड़े किसी भी PR को मर्ज होने से पहले उस पर मंज़ूरी देनी पड़ती (या कम से कम हर मेंटर नोट बदलाव पर उन्हें सूचना मिलती)।
मेंटर नोट्स website-copy रेपो में रखने से हम ये कर सकते हैं:
- ट्रैक मेंटेनरों पर बोझ कम करना
- मेंटर नोट्स की समीक्षा ट्रैक मेंटेनरों से अलग लोगों से भी कराना (वे एक ही लोग हो सकते हैं)
- मेंटर नोट्स पर तेज़ी से इटरेशन की सुविधा देना (ट्रैक मेंटेनर PR मर्ज करते समय अक्सर काफी सख्त होते हैं)
