अपने निम्न-गुणवत्ता वाले Pull Request विवरणों को छिपाने के लिए संकुचित HTML विवरण और सारांश टैग का उपयोग करें।
संकुचित विवरण-सारांश ब्लॉक मनुष्यों को पहले एक छोटा Pull Request ओपनर जोड़ने और लंबे एजेंट नोट्स छिपाने की अनुमति देते हैं, जिससे समीक्षकों को प्रासंगिकता का न्याय करने में मदद मिलती है।
मुख्य जानकारी
- Long AI-एजेंट पुल अनुरोध विवरण समीक्षकों को अभिभूत कर सकते हैं, भले ही वे सटीक हों, इसलिए उन्हें दृश्यमान उद्घाटन पाठ नहीं होना चाहिए।
- उद्देश्य की व्याख्या करने के लिए शीर्ष पर एक छोटा मानव-संरक्षित सारांश जोड़ें और समीक्षकों को यह तय करने में मदद करें कि क्या आगे पढ़ना है।
- विवरण उपलब्ध लेकिन वैकल्पिक रखने के लिए GitHub 'विवरण' / 'सारांश' ब्लॉक में पूर्ण एजेंट-लिखित वर्णन छिपाएं.
- एक संकुचित लेबल का उपयोग करें जो एजेंट मॉडल और प्रयास स्तर को नामित करता है, जैसे कि ∀Claude Opus 5.5 मध्यम`, लंबे पाठ के स्रोत को स्पष्ट करने के लिए।
- जब उपयोगी हो तो screenshots शामिल करें, और याद रखें कि 'सारांश' दृश्य क्लिक करने योग्य शीर्षक है जबकि 'विवरण' छिपी हुई सामग्री को लपेटता है।
मेटा विवरणः Claude Code या कोडेक्स से GitHub खींचने के अनुरोधों का एक व्यावहारिक पैटर्नः पहले एक संक्षिप्त मानव सारांश डालें और विवरण-सारांश में एजेंट विवरण छिपाएं।
टैगः GitHub , खींचने के अनुरोध, Claude Code , कोडेक्स, मार्कडाउन
विशेष रुप से प्रदर्शित छवि: (अंग्रेज़ी में) ">"</string> ![संक्षिप्त विवरण अनुभाग के साथ एक कोड समीक्षा पृष्ठ का सार अनुकूल चित्रण, गोल कार्ड, तीर, नरम रंग, कोई पाठ नहीं]
कई परियोजना परिवर्तन अब Claude Code या कोडेक्स द्वारा खोले गए पुल अनुरोधों के रूप में आते हैं। एक खींचने का अनुरोध काम की इकाई हैः यह समूह प्रतिबद्ध करता है, तब तक पुनरावृत्ति रखता है जब तक कि कोई सुविधा समाप्त नहीं हो जाती है, निर्णय रिकॉर्ड करता है और मर्ज लक्ष्य बन जाता है। चुनौती यह है कि आधुनिक कोडिंग एजेंट ऐसे विवरण तैयार करते हैं जो इतने पूर्ण होते हैं कि वे समीक्षा को हतोत्साहित कर सकते हैं। वे समस्या, विस्तृत समाधान और सत्यापन चरणों की व्याख्या करते हैं। उस सटीकता से उद्घाटन पाठ को दीवार जैसा महसूस किया जा सकता है। फिक्स एजेंट के कार्य को हटाने के लिए नहीं है। यह शीर्ष पर एक मानव निर्णय जोड़ना हैः एक छोटा नोट जो समीक्षक को बताता है कि पुल अनुरोध क्या है और क्या यह ध्यान देने योग्य है।
क्यों एजेंट-लिखित विवरण भारी महसूस कर सकते हैं
एक एजेंट-लिखित पुल अनुरोध विवरण सटीक, व्यापक और अभी भी अवशोषित करने के लिए कठिन हो सकता है। यह आवश्यक रूप से ढलान नहीं है, लेकिन इसे स्लोप की तरह पढ़ा जा सकता है. एजेंट द्वारा लिखे गए पाठ को स्पॉट करना आसान है, और तत्काल प्रतिक्रिया यह हो सकती है कि समीक्षक इसे पूरा नहीं पढ़ेगा। लंबाई एक समीक्षक को तब भी बंद कर सकती है जब जानकारी उपयोगी हो, और यहां तक कि जब पुल अनुरोध का लेखक भी समीक्षक होता है।
एक मानवीय संपादकीय निर्णय वह है जो गायब है। समीक्षक चाहता है कि कोई व्यक्ति मानव-अनुमोदित परिचय तैयार करने के लिए पर्याप्त समय तक सोचता रहे, न कि पूर्ण निबंध। उस परिचय से पाठक को उच्च स्तर पर उद्देश्य को समझने में मदद करनी चाहिए और यह तय करना चाहिए कि पढ़ना जारी रखना है या नहीं।
GitHub विवरण-सारांश पैटर्न
HTML विवरण और सारांश तत्व एक ढह गया ब्लॉक बनाकर इसे हल करते हैं। सारांश दृश्यमान शीर्षक बन जाता है, और विस्तार सामग्री तब तक छिपी रहती है जब तक पाठक इसका विस्तार करने के लिए क्लिक नहीं करता। GitHub Markdown इन टैगों का समर्थन करता है, इसलिए उन्हें सीधे पुल अनुरोध वर्णन या मुद्दे की टिप्पणी में रखा जा सकता है। GitHub सारांश प्लस एक विस्तार तीर प्रदर्शित करता है और बड़े पाठ को छुपाता है।
प्रैक्टिस में, शुरुआती पैराग्राफ मानव-संरचित भाग होता है। यह सबसे छोटा पाठ होना चाहिए जिसका उपयोग पाठक गति प्राप्त करने के लिए कर सकता है। screenshot भी जोड़ा जा सकता है क्योंकि छवियां अक्सर गद्य की तुलना में एक नई सुविधा को तेजी से दिखाती हैं। पूर्ण एजेंट-लिखित विवरण तब विवरण-सारांश ब्लॉक के अंदर आता है। सारांश लेबल मॉडल नाम और प्रयास स्तर हो सकता है, जैसे कि Claude Opus 5.5 मध्यम। इससे लंबे पाठ का स्रोत स्पष्ट हो जाता है।
जानकारी अभी भी मौजूद है, लेकिन एक समीक्षक शीर्ष पर नज़र डाल सकता है और यदि आवश्यक न हो तो विस्तारित अनुभाग को छोड़ सकते हैं। लेखक हमेशा परिचय मैन्युअल रूप से नहीं लिखता है। कभी-कभी एजेंट पहले से ही लंबे पाठ में दफन एक उपयोगी संक्षिप्त सलामी बल्लेबाज का उत्पादन कर चुका होता है। दृश्यमान ओपनिंग बल्लेबजार अभी भी पाठक के लिए एक वादा हैः यह मानव निर्णय है कि उनके समय के लायक क्या है।
एजेंट खींच अनुरोधों पर इसका उपयोग करने के लिए कदम
- Let Claude Code या कोडेक्स पुल अनुरोध खोलें और पूर्ण विवरण उत्पन्न करें।
- एजेंट पाठ को केवल यह समझने के लिए पर्याप्त रूप से पढ़ें कि पुल अनुरोध क्या पूरा करने की कोशिश कर रहा है।
- एक छोटा ओपनर लिखें या चुनें जो उच्च-स्तरीय उद्देश्य और मुख्य परिवर्तन देता है।
- screenshot जोड़ें यदि यह समीक्षक को सुविधा को जल्दी से समझने में मदद करता है।
- पूर्ण एजेंट वर्णन को विवरण-सारांश ब्लॉक में ले जाएँ.
- एक सारांश लेबल का उपयोग करें जो एजेंट मॉडल और प्रयास स्तर को नामित करता है, जैसे Claude Opus 5.5 मध्यम।
- जाँचें कि GitHub विस्तार तीर के साथ एक ढह शीर्षक के रूप में सारांश प्रस्तुत करता है.
- ओपनर को मानव-अनुमोदित भाग के रूप में रखें, भले ही यह एजेंट पाठ से चुना गया हो.
उदाहरण और mnemonic
इस पैटर्न का उपयोग हाल ही में कई पुल अनुरोधों में किया गया है.
- डेटासेट खींच अनुरोध में #3052, शीर्षक फ़ील्ड की एक ऊर्ध्वाधर सूची के रूप में पंक्ति पृष्ठ को फिर से डिज़ाइन करें, ओपनर ने समझाया कि पंक्ति पेज ने एक-पंक्ति तालिका के लिए एकल पंक्ति दिखाई थी। चौड़ी तालिकाओं के लिए, जैसे 46 कॉलम GitHub रिपोजिटरी टेबल, वह लेआउट दाईं ओर स्क्रॉल किया गया था और अधिकांश पृष्ठ खाली छोड़ दिया गया था। इसके बाद screenshot आया।
- डेटासेट खींच अनुरोध में #3043, शीर्षक पेजिंग बार जो दिखाता है कि वर्तमान पृष्ठ पर कौन सी पंक्तियाँ हैं, ओपनर ने कहा कि एक से अधिक पृष्ठों को कवर करने वाले तालिका पृष्ठ अब वर्तमान स्थान स्पष्ट करते हैं और शीर्ष के साथ-साथ नीचे भी नेविगेशन प्रदान करते हैं।
- डेटासेट खींच अनुरोध में #3042, शीर्षक लोड edit-tools.js एक छोटे से लोडर के माध्यम से मांग पर, सलामी बल्लेबाज ने समझाया कि लगभग 220 किलोबाइट्स का संपादन उपकरण .जेएस प्रत्येक तालिका, पंक्ति और डेटाबेस पृष्ठ पर लोड किया गया था, यहां तक कि उन उपयोगकर्ताओं के लिए जो कुछ भी संपादित नहीं कर सकते थे। नया व्यवहार केवल उन उपयोगकर्ताओं को लोड करता है जो पहली बार संपादन सुविधा के साथ बातचीत करते हैं, जिसमें माउस ओवर एडिट लिंक शामिल है।
- डेटासेट-एजेंट खींच अनुरोध में #51, शीर्षक register_agent_reference_types प्लगइन हुक, ओपनर ने एक हुक का वर्णन किया है जो पंजीकरण एजेंट संदर्भ प्रकारों के माध्यम से चैट रचनाकार में अपने स्वयं के आइटम को जोड़ने की अनुमति देता है।
- LLM में खींचने का अनुरोध #1838, शीर्षक LLM OpenAI एंडपॉइंट ऐड/लिस्ट/रिमूव/पाथ कमांड्स जोड़ें, ओपनर ने कहा कि आदेश अतिरिक्त- OpenAI -मॉडल में रिकॉर्ड को प्रबंधित करते हैं ताकि YAML को मैन्युअल रूप से संपादित करने के बजाय कमांड लाइन से OpenAI : संगत अंत बिंदुओं को बचाया जा सके। पुल अनुरोध में कॉपी किए गए --help आउटपुट भी शामिल थे.
लेखक को यह याद रखने में कठिनाई हुई कि क्या विवरण या सारांश पहले आता है। सरल नियम यह है कि सारांश विवरण का सार देता है, इसलिए सारांश क्लिक करने योग्य पंक्ति है और विवरण बाकी सब कुछ लपेटता है। जोड़ी विवरण-सारांश को कॉल करना भी मदद करता हैः यह दो अक्षरों के बाद तीन अक्षर हैं, और यह सारांश-विवरण की तुलना में बेहतर बहती है। इसे ज़ोर से कहना आदेश चिपका सकता है। लेखक अभी भी चाहता है GitHub इसके लिए एक मार्कडाउन संपादक बटन जोड़ देगा, आंशिक रूप से मोबाइल कीबोर्ड पर टाइपिंग को बचाने के लिए और भाग में सुविधा के बारे में जागरूकता फैलाना।
आम गलतियाँ
- यदि समीक्षक पहले कई पैराग्राफ देखता है, तो वे विस्तार या आगे नहीं पढ़ सकते हैं।
- मानव ओपनर को छिपाना. सारांश दिखाई देना चाहिए; ढह गए ब्लॉक में विस्तृत एजेंट स्पष्टीकरण होना चाहिए।
- अस्पष्ट लेबल का उपयोग करना. एक सारांश पंक्ति जैसे Claude Opus 5.5 माध्यम पाठक को बताता है कि अंदर क्या है और यह क्यों लंबा हो सकता है।
- ओपनर को ओवर-एडिटिंग करना. इसे केवल यह तय करने के लिए पर्याप्त उच्च स्तरीय संदर्भ की आवश्यकता है कि क्या गहराई से देखना है।
- यह मानते हुए कि पैटर्न GitHub Markdown के बाहर काम करता है। इसे खींचने के अनुरोधों और टिप्पणी जारी करने के लिए Let Claude Code में समर्थित बताया गया है।
Comments (0)