• टीम के सदस्यों और सहयोगियों को आमंत्रित करें
• एक नया मर्ज रिक्वेस्ट बनाएं
• मर्ज रिक्वेस्ट से इश्यूज़ को स्वचालित रूप से बंद करें
• मर्ज रिक्वेस्ट अनुमोदन सक्षम करें
• ऑटो-मर्ज सेट करें

परीक्षण और परिनियोजन

GitLab में अंतर्निहित निरंतर एकीकरण का उपयोग करें।

• GitLab CI/CD के साथ शुरुआत करें
• Static Application Security Testing (SAST) के साथ ज्ञात कमज़ोरियों के लिए अपने कोड का विश्लेषण करें
• Auto Deploy का उपयोग करके Kubernetes, Amazon EC2, या Amazon ECS पर परिनियोजित करें
• बेहतर Kubernetes प्रबंधन के लिए pull-based परिनियोजन का उपयोग करें
• संरक्षित वातावरण सेट करें

इस README को संपादित करना

जब आप इस README को अपना बनाने के लिए तैयार हों, तो बस इस फ़ाइल को संपादित करें और नीचे दिए गए उपयोगी टेम्पलेट का उपयोग करें (या इसे अपनी इच्छानुसार संरचित करें - यह केवल एक शुरुआती बिंदु है!)। इस टेम्पलेट के लिए makeareadme.com को धन्यवाद।

एक अच्छे README के लिए सुझाव

हर प्रोजेक्ट अलग होता है, इसलिए विचार करें कि इनमें से कौन से अनुभाग आपके प्रोजेक्ट पर लागू होते हैं। टेम्पलेट में उपयोग किए गए अनुभाग अधिकांश ओपन सोर्स प्रोजेक्ट्स के लिए सुझाव हैं। यह भी ध्यान रखें कि जबकि एक README बहुत लंबा और विस्तृत हो सकता है, बहुत लंबा होना बहुत छोटा होने से बेहतर है। यदि आपको लगता है कि आपका README बहुत लंबा है, तो जानकारी काटने के बजाय दस्तावेज़ीकरण के किसी अन्य रूप का उपयोग करने पर विचार करें।

नाम

अपने प्रोजेक्ट के लिए एक स्व-व्याख्यात्मक नाम चुनें।

विवरण

लोगों को बताएं कि आपका प्रोजेक्ट विशेष रूप से क्या कर सकता है। संदर्भ प्रदान करें और किसी भी संदर्भ का लिंक जोड़ें जिससे आगंतुक परिचित न हों। यहां एक Features या Background उपधारा भी जोड़ी जा सकती है। यदि आपके प्रोजेक्ट के विकल्प हैं, तो यह विभेदक कारकों को सूचीबद्ध करने के लिए एक अच्छी जगह है।

बैज

कुछ READMEs पर, आप छोटी छवियां देख सकते हैं जो मेटाडेटा बताती हैं, जैसे कि प्रोजेक्ट के लिए सभी परीक्षण पास हो रहे हैं या नहीं। आप अपने README में कुछ जोड़ने के लिए Shields का उपयोग कर सकते हैं। कई सेवाओं में बैज जोड़ने के निर्देश भी होते हैं।

दृश्य

आप जो बना रहे हैं उसके आधार पर, स्क्रीनशॉट या यहां तक कि एक वीडियो शामिल करना एक अच्छा विचार हो सकता है (आप अक्सर वास्तविक वीडियो के बजाय GIFs देखेंगे)। ttygif जैसे टूल्स मदद कर सकते हैं, लेकिन अधिक परिष्कृत तरीके के लिए Asciinema देखें।

स्थापना

किसी विशेष पारिस्थितिकी तंत्र में, चीजों को स्थापित करने का एक सामान्य तरीका हो सकता है, जैसे Yarn, NuGet, या Homebrew का उपयोग करना। हालांकि, इस संभावना पर विचार करें कि आपका README पढ़ने वाला कोई नौसिखिया है और अधिक मार्गदर्शन चाहता है। विशिष्ट चरणों को सूचीबद्ध करने से अस्पष्टता दूर होती है और लोगों को जल्द से जल्द आपके प्रोजेक्ट का उपयोग करने में मदद मिलती है। यदि यह केवल एक विशिष्ट संदर्भ में चलता है जैसे कि कोई विशेष प्रोग्रामिंग भाषा संस्करण या ऑपरेटिंग सिस्टम या इसमें निर्भरताएं हैं जिन्हें मैन्युअल रूप से स्थापित करना होता है, तो एक Requirements उपधारा भी जोड़ें।

उपयोग

उदाहरणों का उदारतापूर्वक उपयोग करें, और यदि संभव हो तो अपेक्षित आउटपुट दिखाएं। उपयोग का सबसे छोटा उदाहरण इनलाइन रखना मददगार होता है जिसे आप प्रदर्शित कर सकते हैं, साथ ही अधिक परिष्कृत उदाहरणों के लिंक प्रदान करना यदि वे README में शामिल करने के लिए बहुत लंबे हों।

सहायता

लोगों को बताएं कि वे मदद के लिए कहां जा सकते हैं। यह एक इश्यू ट्रैकर, चैट रूम, ईमेल पता, आदि का कोई भी संयोजन हो सकता है।

रोडमैप

यदि आपके पास भविष्य में रिलीज़ के लिए विचार हैं, तो उन्हें README में सूचीबद्ध करना एक अच्छा विचार है।

योगदान

बताएं कि क्या आप योगदान के लिए खुले हैं और उन्हें स्वीकार करने के लिए आपकी क्या आवश्यकताएं हैं।

जो लोग अपने प्रोजेक्ट में बदलाव करना चाहते हैं, उनके लिए शुरुआत करने के तरीके पर कुछ दस्तावेज़ीकरण होना मददगार होता है। शायद कोई स्क्रिप्ट है जिसे उन्हें चलाना चाहिए या कुछ पर्यावरण चर जिन्हें उन्हें सेट करना है। इन चरणों को स्पष्ट करें। ये निर्देश आपके भविष्य के स्वयं के लिए भी उपयोगी हो सकते हैं।

आप कोड को लिंट करने या परीक्षण चलाने के लिए कमांड का दस्तावेज़ीकरण भी कर सकते हैं। ये चरण उच्च कोड गुणवत्ता सुनिश्चित करने और संभावना को कम करने में मदद करते हैं कि परिवर्तन अनजाने में कुछ तोड़ दें। परीक्षण चलाने के निर्देश विशेष रूप से मददगार होते हैं यदि इसके लिए बाहरी सेटअप की आवश्यकता होती है, जैसे ब्राउज़र में परीक्षण के लिए Selenium सर्वर शुरू करना।

लेखक और आभार

प्रोजेक्ट में योगदान देने वालों के प्रति अपना आभार व्यक्त करें।

लाइसेंस

ओपन सोर्स प्रोजेक्ट्स के लिए, बताएं कि यह कैसे लाइसेंस प्राप्त है।

प्रोजेक्ट स्थिति

यदि आपने अपने प्रोजेक्ट के लिए ऊर्जा या समय खत्म कर दिया है, तो README के शीर्ष पर एक नोट डालें कि विकास धीमा हो गया है या पूरी तरह से रुक गया है। कोई आपके प्रोजेक्ट को फोर्क करना चुन सकता है या अनुरक्षक या स्वामी के रूप में कदम रखने के लिए स्वेच्छा से आगे आ सकता है, जिससे आपका प्रोजेक्ट चलता रह सकता है। आप अनुरक्षकों के लिए एक स्पष्ट अनुरोध भी कर सकते हैं।