सीखने के सभी रास्ते समझें देखें करें बनाएँ ऐसी समीक्षा लिखें जिस पर काम हो सके यह पाठ किस बारे में है एक पंक्ति की ओर इशारा करें, टूटा हुआ नियम बताएँ, और लिखें कि उसकी जगह क्या आना चाहिए। बाकी कुछ नहीं।
जिस उत्तर की आप समीक्षा कर रहे हैं, उसमें एक जगह गलती दब जाती है और लिखने वाला इंतज़ार में है। आप क्या भेजेंगे?
A लिख दें कि गलती सँभालना कमज़ोर है और नाम ज़्यादा साफ़ हो सकते थे। B एक टिप्पणी में एक पंक्ति, एक नियम, और उसकी जगह क्या लिखना है — यही तीनों हों। C जिस जगह गड़बड़ है उसका अंक और टूटा हुआ नियम भेज दें, और सुधार उसे खुद निकालने दें।
याद जाँचें यह काम क्यों ज़रूरी है समीक्षा के पैसे इस बात के मिलते हैं कि लिखने वाला उससे क्या कर पाया। जो टिप्पणी पंक्ति बताए और बदला हुआ पाठ दे, वह समीक्षा के पन्ने से सीधे लगाई जा सकती है। 'कोड बेहतर हो सकता है' जैसी टिप्पणी एक जवाब और एक दिन खा जाती है।
ऐसी समीक्षा-टिप्पणियाँ लिखें जिन्हें लिखने वाला उसी दिन लगा सके, बिना कुछ पूछे।
समीक्षा के पैसे इस बात के मिलते हैं कि लिखने वाला उससे क्या कर पाया। जो टिप्पणी पंक्ति बताए और बदला हुआ पाठ दे, वह समीक्षा के पन्ने से सीधे लगाई जा सकती है। 'कोड बेहतर हो सकता है' जैसी टिप्पणी एक जवाब और एक दिन खा जाती है।
एक टिप्पणी में एक पंक्ति, एक नियम, और उसकी जगह क्या लिखना है — यही तीनों हों। जो बदलना ज़रूरी है और जो आप अपनी तरह से करते, दोनों अलग रखें और नाम देकर लिखें। ऐसे लिखें कि लिखने वाला आपसे मतलब पूछे बिना काम कर सके। काम किसी जाँच प्रोजेक्ट के एक उत्तर पर तीन समीक्षा-टिप्पणियाँ लिखें।
कमज़ोर तरीका लिखना कि गलती सँभालना कमज़ोर है और नाम साफ़ नहीं हैं। फ़ाइल छोटे हिस्सों में बँटी हो तो पढ़ने में बेहतर रहेगी। तीनों टिप्पणियों में कहीं पंक्ति का अंक नहीं आता।
बेहतर तरीका पहली टिप्पणी: पंक्ति 22 में गलती दब जाती है, और उसकी जगह वह पंक्ति दी गई है जो गलती को ऊपर भेज देती है। दूसरी: n का नाम बदलकर 'पंक्ति-गिनती' रखें। तीसरी पर लिखा है कि यह सिर्फ़ पसंद है: लूप बाँट दें।
बेहतर तरीका क्यों काम करता है कमज़ोर टिप्पणियाँ न पंक्ति बताती हैं न बदला हुआ पाठ। मज़बूत टिप्पणियाँ लगाई जा सकती हैं, और जो सिर्फ़ पसंद है उस पर नाम भी लिखा है।
बदली हुई स्थिति आज़माएँ आप किसी स्कूली छात्रा का पहला प्रोग्राम देख रहे हैं। आपकी आधी टिप्पणियाँ असली गलतियाँ हैं और आधी आपकी अपनी आदतें। आप उन्हें कैसे भेजेंगे?
अब खुद बनाकर देखें एक उत्तर की समीक्षा तीन टिप्पणियों में लिखें। हर एक में पंक्ति, टूटा हुआ नियम, और ठीक-ठीक बदला हुआ पाठ हो। जो टिप्पणी गलती नहीं, आपकी पसंद है, उस पर वैसा लिख दें।
जाँच के काम के लिए कोडिंग: 10 में से पाठ 10 आगे एजेंट असल में करता क्या है भाग 3 के आख़िर में आपके काम का नमूना बनता है, जिसे आप भेज सकते हैं जिन नियमों से यह काम का नमूना पढ़ा जाता है, एक बने हुए उदाहरण के साथ
मूल या आधिकारिक स्रोत पढ़ें: GitHub Docs · Commenting on a pull request