एक मेंटेनर के तौर पर पुल रिक्वेस्ट की समीक्षा करना आपका नियमित काम होगा।
इस दस्तावेज़ में Exercism से जुड़े पुल रिक्वेस्ट समीक्षा के कुछ दिशानिर्देश दिए गए हैं।
अभ्यासों के पुल रिक्वेस्ट की समीक्षा
कॉन्सेप्ट अभ्यास या प्रैक्टिस अभ्यास के लिए पुल रिक्वेस्ट की समीक्षा करना भारी लग सकता है, क्योंकि इन तरह के अभ्यासों से जुड़े नियम बहुत सारे हैं।
इसी वजह से किसी मेंटेनर को पहले दौर की समीक्षा करने में अक्सर दो से तीन घंटे लगते हैं और दर्जनों टिप्पणियाँ निकलती हैं।
कॉन्सेप्ट अभ्यासों में ऐसी फाइलें भी होती हैं जिनके लक्ष्य और सामग्री एक जैसे होते हैं (जैसे अभ्यास का परिचय और कॉन्सेप्ट का परिचय), इसलिए बहुत दूर तक फैलने से पहले इनमें से एक को पूरी तरह दुरुस्त कर लेना ज़रूरी है।
इस वर्कफ्लो को आसान बनाने के लिए हमने ये सुझाव तैयार किए हैं।
सुझाव: पहले दौर की समीक्षा एक ही वरिष्ठ मेंटेनर के ज़िम्मे रहे
पहले दौर की समीक्षा ठीक एक वरिष्ठ मेंटेनर के ज़िम्मे रखने की वजहें ये हैं:
- समीक्षा का काम दो बार नहीं होता
- कंट्रिब्यूटर और मेंटेनर मिलकर पुल रिक्वेस्ट पर काम करते हैं, जिससे कंट्रिब्यूटर को लगता है कि वे यह अकेले नहीं कर रहे
- दूसरे मेंटेनरों की तरफ से आपस में टकराने वाली समीक्षा टिप्पणियाँ नहीं आतीं
सुझाव: wip स्टेटस के साथ मर्ज कीजिए
एक बार कंट्रिब्यूटर और मेंटेनर दोनों अभ्यास से खुश हो जाएँ, तो अभ्यास को उसका status wip (कार्य प्रगति पर) पर सेट करके मर्ज कर देना चाहिए।
इस स्टेटस वाले अभ्यास छात्रों के लिए उपलब्ध नहीं होंगे, लेकिन हमारे शीर्ष मेंटर उन्हें देख पाएँगे (जब हम इसे भविष्य में कभी लागू करेंगे)।
इसके बाद ये ऊँची रेपुटेशन वाले यूज़र अभ्यास को परख सकते हैं और उसे ठीक करने या बेहतर बनाने के लिए इश्यू या पुल रिक्वेस्ट बना सकते हैं।
इस तरीके के मुख्य फायदे ये हैं:
- मूल कंट्रिब्यूटर और मेंटेनर की जोड़ी पर सब कुछ सही करने का बोझ नहीं पड़ता
- ऐसे बहुत बड़े पुल रिक्वेस्ट चक्र नहीं बनते जिनमें कई आवाज़ें हों (और जिन्हें सँभालना बहुत मुश्किल होता है)
प्रैक्टिस अभ्यास के पुल रिक्वेस्ट की समीक्षा
सुझाव: सोचिए कि बदलाव वाकई problems-specifications में होना चाहिए या नहीं
प्रैक्टिस अभ्यास की कुछ सामग्री (जैसे उसका परिचय) उसके साझा मेटाडेटा से आती है, जो problems-specifications रिपॉज़िटरी में परिभाषित होता है।
ऐसी सामग्री बदलने वाले पुल रिक्वेस्ट की समीक्षा करते समय सोचिए कि क्या यह बदलाव दूसरे ट्रैक के लिए भी फायदेमंद हो सकता है।
अगर हाँ, तो कंट्रिब्यूटर से कहिए कि वह problems-specifications रिपॉज़िटरी की उससे जुड़ी फाइल पर पुल रिक्वेस्ट खोले।
समीक्षा के सामान्य सुझाव
सुझाव: हर पुल रिक्वेस्ट पर एक मुख्य समीक्षक
सभी पुल रिक्वेस्ट पर एक मुख्य समीक्षक होना चाहिए (जो भी मेंटेनर उसे उठाए)।
बाकी मेंटेनरों और/या कम्युनिटी के सदस्यों को सहायक भूमिका में रहना चाहिए।
सहायक भूमिका में रहने वाला कोई व्यक्ति दो मुख्य तरीकों से समीक्षा में योगदान दे सकता है:
- वर्तनी और व्याकरण की जाँच कीजिए, लेकिन मुख्य समीक्षक का पहला दौर पूरा होने के बाद ही।
कंट्रिब्यूटर के लिए यह निराशाजनक हो सकता है कि पहले उन्हें वर्तनी और व्याकरण की समीक्षा मिले, वे उसे ठीक करें, और फिर कोई मेंटेनर आकर उनसे और बुनियादी बदलाव करने को कहे।
यानी वर्तनी की जाँच वह काम है जो बुनियादी बदलाव तय होने के बाद कीजिए (या ज़रूरत पड़े तो किसी अलग फॉलो-अप पुल रिक्वेस्ट में)।
- किसी बात की ओर समीक्षक का ध्यान ऐसे तरीके से खींचिए जिसमें कुछ करने को कहा न जाए।
अगर आप ऐसी बातों पर टिप्पणी कर रहे हैं जिनके बारे में मुख्य समीक्षक को सोचना चाहिए या जो उनसे छूट गई हो सकती हैं, तो अपनी टिप्पणी में अपनी राय ज़ाहिर कीजिए या उसे सवाल के रूप में लिखिए।
इससे कंट्रिब्यूटर को साफ पता चलता है कि आप उनसे बदलाव करने को नहीं कह रहे, और उन्हें कम उलझन होती है।
इससे यह भी कम होगा कि मुख्य समीक्षक को लगे कि उन्हें कमतर आँका जा रहा है।
सुझाव: असंबंधित बातों पर टिप्पणी न कीजिए
पुल रिक्वेस्ट की समीक्षा करते समय सिर्फ उन्हीं बातों पर टिप्पणी कीजिए जिनका पुल रिक्वेस्ट से सीधा संबंध हो।
बाकी किसी भी बात के लिए इश्यू खोलिए या अलग (फॉलो-अप) पुल रिक्वेस्ट बनाइए।
सुझाव: दस्तावेज़ों का लिंक दीजिए
जहाँ संभव हो, हमेशा ऐसे दस्तावेज़ का लिंक देने की कोशिश कीजिए जिसमें यह समझाया गया हो कि आप किसी बात पर टिप्पणी क्यों कर रहे हैं।
इससे बातों के बहस में बदलने का खतरा बहुत कम हो जाता है।
सुझाव: दूसरी टीमों से मदद माँगिए
अगर आप किसी पुल रिक्वेस्ट की समीक्षा में मदद माँगना चाहते हैं, तो हमारे पास दो खास टीमें हैं जिन्हें आप पिंग कर सकते हैं:
-
@exercism/reviewers: किसी भी सामान्य समीक्षा के लिए
-
@exercism/github-actions: GitHub actions से जुड़े किसी भी सवाल के लिए
