dcsgonefwbsp

आरंभ करना

GitLab के साथ शुरुआत करना आपके लिए आसान बनाने के लिए, यहाँ अनुशंसित अगले कदमों की एक सूची दी गई है।

पहले से ही एक प्रो? बस इस README.md को संपादित करें और इसे अपना बनाएँ। इसे आसान बनाना चाहते हैं? नीचे दिए गए टेम्पलेट का उपयोग करें!

अपनी फ़ाइलें जोड़ें

• फ़ाइलें बनाएँ या अपलोड करें
• कमांड लाइन का उपयोग करके फ़ाइलें जोड़ें या निम्नलिखित कमांड के साथ किसी मौजूदा Git रिपॉजिटरी को पुश करें:

cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main

अपने टूल्स के साथ एकीकृत करें

• प्रोजेक्ट इंटीग्रेशन सेट अप करें

अपनी टीम के साथ सहयोग करें

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

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

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

• GitLab CI/CD के साथ शुरुआत करें
• स्टैटिक एप्लिकेशन सिक्योरिटी टेस्टिंग (SAST) के साथ ज्ञात कमजोरियों के लिए अपने कोड का विश्लेषण करें
• ऑटो डिप्लॉय का उपयोग करके Kubernetes, Amazon EC2, या Amazon ECS पर परिनियोजित करें
• बेहतर Kubernetes प्रबंधन के लिए पुल-आधारित परिनियोजन का उपयोग करें
• संरक्षित वातावरण सेट अप करें

---

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

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

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

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

नाम

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

विवरण

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

बैज

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

दृश्य

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

स्थापना

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

उपयोग

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

समर्थन

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

रोडमैप

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

योगदान

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

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

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

लेखक और स्वीकृति

उन लोगों के प्रति अपनी कृतज्ञता व्यक्त करें जिन्होंने प्रोजेक्ट में योगदान दिया है।

लाइसेंस

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

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

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