कोई भी प्रलेखन पुल रिक्वेस्ट की समीक्षा कर सकता है। ओपन पुल रिक्वेस्ट को देखने के लिए
कुबेरनेट्स वेबसाइट की रिपॉजिटरी में पुल रिक्वेस्ट अनुभाग पर जाएँ।
प्रलेखन पुल रिक्वेस्ट की समीक्षा करना, कुबेरनेट्स समुदाय से अपना परिचय कराने का एक शानदार तरीका है।
यह आपको कोड बेस सीखने और अन्य योगदानकर्ताओं के साथ विश्वास बनाने में मदद करता है।
CNCF आचार संहिता पढ़ें और सुनिश्चित करें कि आप हर समय इसका पालन कर रहे हो।
विनम्र, विचारशील और मददगार बनें।
पुल रिक्वेस्ट के सकारात्मक पहलुओं के साथ-साथ परिवर्तनों पर टिप्पणी करें।
आपकी समीक्षा किस प्रकार लिया जा सकता है, इस बारे में सहानुभूतिपूर्ण रूप से सावधान रहें।
अच्छी मंशा मानें और स्पष्ट प्रश्न पूछें।
अनुभवी योगदानकर्ता, नए योगदानकर्ताओं के साथ जोड़ी बनाने पर विचार करें जिनके कार्य में अधिक परिवर्तन की आवश्यकता है।
पुनरावलोकन प्रक्रिया
सामान्य तौर पर, अंग्रेज़ी में सामग्री और शैली के लिए पुल रिक्वेस्ट की समीक्षा करें। चित्र 1
समीक्षा प्रक्रिया के चरणों को रेखांकित करता है। प्रत्येक चरण का विवरण इस प्रकार है।
flowchart LR
subgraph fourth[समीक्षा शुरू करें]
direction TB
S[ ] -.-
M[टिप्पणियाँ लिखें] --> N[परिवर्तनों की समीक्षा करें]
N --> O[नए योगदानकर्ताओं को टिप्पणी का चयन करना चाहिए]
end
subgraph third[पुल रिक्वेस्ट का चयन करें]
direction TB
T[ ] -.-
J[विवरण और टिप्पणियाँ पढ़ें]--> K[Netlify प्रीव्यू बिल्ड के साथ अपने परिवर्तनों का पूर्वावलोकन करें]
end
A[खुली पुल रिक्वेस्ट सूची की समीक्षा करें]--> B[खुले पुल रिक्वेस्ट को लेबल द्वारा फ़िल्टर करें]
B --> third --> fourth
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,J,K,M,N,O grey
class S,T spacewhite
class third,fourth white
निम्नलिखित में से एक या सभी लेबलों का उपयोग करके खुले PR को फ़िल्टर करें:
cncf-cla: yes (अनुशंसित): जिन योगदानकर्ताओं ने CLA पर हस्ताक्षर नहीं किए हैं, उनके PR का विलय नहीं किया जा सकता है। अधिक जानकारी के लिए CLA पर हस्ताक्षर करें देखें।
language/en (अनुशंसित): केवल अंग्रेजी भाषा में PR देखने के लिए फ़िल्टर।
size/<size>: एक निश्चित आकार के PR के लिए फ़िल्टर। यदि आप नए हैं, तो छोटे PR से शुरुआत करें।
इसके अतिरिक्त, सुनिश्चित करें कि पुल रिक्वेस्ट को कार्य प्रगति में है के रूप में चिह्नित नहीं किया गया है। work in progress लेबल का उपयोग करने वाले पीआर अभी तक समीक्षा के लिए तैयार नहीं हैं।
समीक्षा के लिए एक PR चुनने के बाद, किए गए परिवर्तनों को निम्नलिखित तरीकों से समझा जा सकता है:
किए गए परिवर्तनों को समझने के लिए PR विवरण पढ़ें, और इससे जुड़े किसी भी मुद्दे को पढ़ें।
अन्य समीक्षकों द्वारा दी गई टिप्पणियां पढ़ें।
फाइलों और पंक्तियों में बदलाव देखने के लिए Files changed टैब पर क्लिक करें।
Conversation टैब के नीचे PR के बिल्ड चेक सेक्शन तक स्क्रॉल करके Netlify प्रीव्यू बिल्ड में बदलावों का पूर्वावलोकन करें
यहाँ एक स्क्रीनशॉट है। (यह GitHub की डेस्कटॉप साइट दिखाता है; यदि आप टेबलेट या स्मार्टफोन डिवाइस पर समीक्षा कर रहे हैं, तो GitHub वेब UI थोड़ा अलग होगा):
पूर्वावलोकन खोलने के लिए, चेक की सूची में deploy/netlify लाइन के Details लिंक पर क्लिक करें।
अपनी समीक्षा शुरू करने के लिए Files changed टैब पर जाएं।
जिस पंक्ति पर आप टिप्पणी करना चाहते हैं, उसके बगल में स्थित + चिन्ह पर क्लिक करें।
पंक्ति के बारे में आपके पास कोई भी टिप्पणी भरें और Add single comment (यदि आपके पास करने के लिए केवल एक टिप्पणी है) पर क्लिक करें या Start a review (यदि आपको कई टिप्पणियां करनी हैं)
समाप्त होने पर, पृष्ठ के शीर्ष पर Review changes पर क्लिक करें। यहां, आप अपनी समीक्षा का सारांश जोड़ सकते हैं (और योगदानकर्ता के लिए कुछ सकारात्मक टिप्पणियाँ छोड़ें!)
अपनी समीक्षा समाप्त करते समय "Request changes" बटन पर क्लिक करने से बचें।
यदि आप कुछ और बदलाव करने से पहले PR का विलय होने से रोकना चाहते हैं, तो आप "/hold" टिप्पणी छोड़ सकते हैं।
उल्लेख करें कि आप होल्ड क्यों सेट कर रहे हैं, और वैकल्पिक रूप से उन शर्तों को निर्दिष्ट करें जिनके तहत होल्ड को आपके या अन्य समीक्षकों द्वारा हटाया जा सकता है।
अपनी समीक्षा समाप्त करते समय "Approve" बटन पर क्लिक करने से बचें।
अधिकांश समय "/approve" टिप्पणी छोड़ने की सिफारिश की जाती है।
चेकलिस्ट की समीक्षा करना
समीक्षा करते समय, प्रारंभिक बिंदु के रूप में निम्न का उपयोग करें।
भाषा और व्याकरण
क्या भाषा या व्याकरण में कोई स्पष्ट त्रुटियाँ हैं? क्या कुछ वाक्यांश करने का कोई बेहतर तरीका है?
पृष्ठ के उन हिस्सों की भाषा और व्याकरण पर ध्यान दें जिन्हें लेखक बदल रहा है।
जब तक लेखक स्पष्ट रूप से पूरे पृष्ठ को अपडेट करने का लक्ष्य नहीं रखता है, तब तक पृष्ठ पर प्रत्येक समस्या को ठीक करने का उनका कोई दायित्व नहीं है।
जब कोई पुल रिक्वेस्ट किसी मौजूदा पेज को अपडेट करता है, तो आपको पेज के उन हिस्सों की समीक्षा करने पर ध्यान देना चाहिए जिन्हें अपडेट किया जा रहा है। उस बदली हुई सामग्री की तकनीकी और संपादकीय शुद्धता के लिए समीक्षा की जानी चाहिए।
यदि आपको पृष्ठ पर त्रुटियां मिलती हैं जो पुल रिक्वेस्ट लेखक द्वारा संबोधित करने का प्रयास करने से सीधे संबंधित नहीं होती हैं, तो इसे एक अलग मुद्दे के रूप में माना जाना चाहिए (पहले जांचें कि इस बारे में कोई मौजूदा समस्या तो नहीं है)।
सामग्री को स्थानांतरित करने वाले पुल अनुरोधों से सावधान रहें। यदि कोई लेखक किसी पृष्ठ का नाम बदलता है या दो पृष्ठों को जोड़ता है, तो हम (कुबेरनेट्स SIG Docs) आमतौर पर उस लेखक से प्रत्येक व्याकरण या वर्तनी इकाई को ठीक करने के लिए कहने से बचते हैं जिसे हम उस स्थानांतरित सामग्री में खोज सकते हैं।
क्या कोई जटिल या पुराना शब्द है जिसे सरल शब्द से बदला जा सकता है?
क्या ऐसे कोई शब्द या वाक्यांश उपयोग में हैं जिन्हें गैर-भेदभावपूर्ण विकल्प से बदला जा सकता है?
क्या शब्द का चुनाव और उसका कैपिटलाइज़ेशन शैली गाइड का पालन करता है?
क्या ऐसे लंबे वाक्य हैं जो छोटे या कम जटिल हो सकते हैं?
क्या कोई लंबा पैराग्राफ है जो सूची या तालिका के रूप में बेहतर काम कर सकता है?
सामग्री
क्या इसी तरह की सामग्री कुबेरनेट्स साइट पर कहीं और मौजूद है?
क्या सामग्री ऑफ-साइट, व्यक्तिगत विक्रेता या गैर-ओपन सोर्स दस्तावेज़ीकरण से अत्यधिक लिंक करती है?
वेबसाइट
क्या इस पुल रिक्वेस्ट ने पृष्ठ शीर्षक, स्लग/उपनाम या एंकर लिंक को बदल दिया या हटा दिया? यदि हां, तो क्या इस पीआर के परिणामस्वरूप टूटे लिंक हैं? क्या कोई अन्य विकल्प है, जैसे स्लग को बदले बिना पृष्ठ का शीर्षक बदलना?
क्या पुल रिक्वेस्ट एक नया पृष्ठ पेश करता है? यदि ऐसा है तो:
क्या पृष्ठ सही पृष्ठ सामग्री प्रकार और संबद्ध ह्यूगो शॉर्टकोड का उपयोग कर रहा है?
क्या पेज सेक्शन के साइड नेविगेशन में ठीक से दिखाई देता है?
क्या परिवर्तन Netlify पूर्वावलोकन में दिखाई देते हैं? सूचियों, कोड, ब्लॉकों, तालिकाओं, नोट्स और छवियों के बारे में विशेष रूप से सतर्क रहें।
अन्य
इसे ध्यान से देखें सरल संपादन;
यदि आपको कोई परिवर्तन दिखाई देता है जो आपको लगता है कि एक सरल संपादन है, तो कृपया उस नीति को इंगित करें
(यदि यह वास्तव में सुधार है तो परिवर्तन को स्वीकार करना अभी भी ठीक है)।
उन लेखकों को प्रोत्साहित करें जो अपने पुल रिक्वेस्ट की पहली प्रतिबद्धता में ऐसा करने के लिए व्हॉट्सएप फिक्स कर रहे हैं, और उसके बाद अन्य परिवर्तन जोड़ें। यह विलय और समीक्षा दोनों को आसान बनाता है। विशेष रूप से एक छोटे से परिवर्तन के लिए देखें जो एक बड़ी मात्रा में व्हाइटस्पेस क्लीनअप के साथ होता है (और यदि आप इसे देखते हैं, तो लेखक को इसे ठीक करने के लिए प्रोत्साहित करें)।
एक समीक्षक के रूप में, यदि आप पुल रिक्वेस्ट के साथ छोटे मुद्दों की पहचान करते हैं जो अर्थ के लिए आवश्यक नहीं हैं, जैसे टाइपो या गलत व्हाइटस्पेस, अपनी टिप्पणियों को nit: के साथ उपसर्ग करें।
इससे लेखक को पता चलता है कि आपकी प्रतिक्रिया का यह हिस्सा गैर-महत्वपूर्ण है।
यदि आप अनुमोदन के लिए एक पुल रिक्वेस्ट पर विचार कर रहे हैं और शेष सभी फीडबैक को nit के रूप में चिह्नित किया गया है, तो आप वैसे भी पुल रिक्वेस्ट को मर्ज कर सकते हैं। उस स्थिति में, शेष nits के बारे में एक समस्या खोलना अक्सर उपयोगी होता है। विचार करें कि क्या आप नए मुद्दे को good first issue के रूप में चिह्नित करने के लिए आवश्यकताओं को पूरा करने में सक्षम हैं यदि आप कर सकते हैं, तो ये एक अच्छे स्रोत हैं।
