cryptohackapp

शुरू करना

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

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

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

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

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

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

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

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

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

परीक्षण और तैनाती

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

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

---

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

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

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

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

नाम

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

विवरण

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

बैज (Badges)

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

दृश्य (Visuals)

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

स्थापना (Installation)

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

उपयोग (Usage)

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

समर्थन (Support)

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

रोडमैप (Roadmap)

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

योगदान (Contributing)

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

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

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

लेखक और स्वीकृति (Authors and acknowledgment)

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

लाइसेंस (License)

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

प्रोजेक्ट स्थिति (Project status)

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