कभी-कभी संपूर्ण रूप में भंडार में स्रोत कोड के बारे में प्रतिक्रिया छोड़ना आवश्यक होता है, उदाहरण के लिए, जब अन्य डेवलपर्स से समर्थन के लिए कोड को स्वीकार करते समय या किसी नई परियोजना से कनेक्ट करते समय।
गितुब और इसके एनालॉग्स में समीक्षा प्रक्रियाएं किए गए परिवर्तनों के आसपास निर्मित होती हैं, और हमारे मामले में, टिप्पणियों के समय टिप्पणियों को संपूर्ण सिस्टम कोड की स्थिति को दिए जाने की आवश्यकता होती है।
इसे स्वयं कैसे उपयोग कर सकते हैं: समीक्षा शाखा में स्थिति को ठीक करें, फिर इस शाखा के लिए मर्ज अनुरोध में अपनी टिप्पणी छोड़ दें।
सामान्य तौर पर, विधि का सार पहले ही बताया जा चुका है, नीचे कुछ विवरण हैं।
मुद्दा
स्थिति की कल्पना करें: वे आपको कोड के साथ एक भंडार देते हैं और उस पर आपकी राय के लिए पूछते हैं। आमतौर पर ऐसे मामलों में, एक अलग दस्तावेज़ / कार्य / संगम में पृष्ठ, आदि में टिप्पणियां की जाती हैं, जो कि बहुत सुविधाजनक नहीं है:
- लेखन प्रक्रिया के दौरान टिप्पणियाँ पुरानी हो सकती हैं, क्योंकि विकास जारी रह सकता है।
- कोड के अलग-अलग वर्गों को संदर्भित करना मुश्किल है, सन्दर्भ संदिग्ध / बार.जैस: 4 दस्तावेज़ और कोड के बीच लगातार स्विच करने के लिए बस असुविधाजनक हैं ।
- कोड से अलगाव में, दस्तावेज़ एक उच्च संभावना के साथ खो जाता है।
सिस्टम कोड समीक्षा विधि
तो, हमें निम्नलिखित करने की आवश्यकता है: समीक्षा के लिए शाखा में स्थिति को ठीक करें, फिर इस शाखा के लिए मर्ज अनुरोध में अपनी टिप्पणी छोड़ दें।
नोट के लिए तैयार रिपॉजिटरी के उदाहरण का उपयोग करके https://github.com/oktend/system-review-example, हम इन चरणों को करेंगे:
- समीक्षा के लिए रिपॉजिटरी में स्थिति का पता लगाएं (समीक्षा के समय यह ईश्वर में अंतिम वचन था):
https://github.com/oktend/system-review-example/commit/05/14531a35edf191970324949fffafdda9f83efe - चयनित राज्य से शाखा हमारे सिस्टम की समीक्षा के लिए एक शाखा, उदाहरण के लिए, "सिस्टम-समीक्षा / 1march2020-goodman":
https://github.com/oktend/system-review-example/tree/system-review/1march2020-goodman - , , "1march2020-goodman-issues":
https://github.com/oktend/system-review-example/tree/system-review/1march2020-goodman-issues - , , .
- merge request ( pull request) "system-review/1march2020-goodman-issues" -> "system-review/1march2020-goodman":
https://github.com/oktend/system-review-example/pull/1/files
:
https://github.com/oktend/system-review-example/network
merge request , .
, .
:
https://github.com/oktend/system-review-example/blob/c80b03710059b235347ec781bf08dca9c0e68f7d/review-1march2020-goodman.md
:
https://github.com/oktend/system-review-example/blob/c80b03710059b235347ec781bf08dca9c0e68f7d/foo.js
- github ( ), IDE, git.
, .
मैं इस संभावना को पूरी तरह स्वीकार करता हूं कि मैंने साइकिल का फिर से आविष्कार किया और इस तरह के मामलों के लिए एक बेहतर तरीका है, तो मैं सबसे अच्छा तरीका बताने के लिए आभारी रहूंगा।
इस पद्धति का विचार मेरे द्वारा आविष्कार नहीं किया गया था, लेकिन एक डेवलपर ने सुझाव दिया, अगर आर्टेम एक इच्छा व्यक्त करता है, तो मैं लेखक के रूप में इंगित करूंगा।