
Java प्रोजेक्ट्स को pom.xml या build.gradle के माध्यम से स्कैन करें — Maven/Gradle निर्भरताओं के लिए CVE मिलान
GitLab के साथ आपको शुरू करना आसान बनाने के लिए, यहाँ अनुशंसित अगले चरणों की एक सूची दी गई है।
पहले से ही विशेषज्ञ हैं? बस इस README.md को संपादित करें और इसे अपना बनाएं। इसे आसान बनाना चाहते हैं? नीचे दिए गए टेम्पलेट का उपयोग करें!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/java-cve-scanner.git
git branch -M main
git push -uf origin main
GitLab में अंतर्निहित निरंतर एकीकरण का उपयोग करें।
जब आप इस README को अपना बनाने के लिए तैयार हों, तो बस इस फ़ाइल को संपादित करें और नीचे दिए गए उपयोगी टेम्पलेट का उपयोग करें (या इसे अपनी इच्छानुसार संरचित करने के लिए स्वतंत्र महसूस करें - यह केवल एक शुरुआती बिंदु है!)। इस टेम्पलेट के लिए makeareadme.com को धन्यवाद।
हर प्रोजेक्ट अलग होता है, इसलिए विचार करें कि इनमें से कौन से अनुभाग आपके प्रोजेक्ट पर लागू होते हैं। टेम्पलेट में उपयोग किए गए अनुभाग अधिकांश ओपन सोर्स प्रोजेक्ट्स के लिए सुझाव हैं। यह भी ध्यान रखें कि हालांकि एक README बहुत लंबा और विस्तृत हो सकता है, लेकिन बहुत लंबा होना बहुत छोटा होने से बेहतर है। यदि आपको लगता है कि आपका README बहुत लंबा है, तो जानकारी काटने के बजाय दस्तावेज़ीकरण के किसी अन्य रूप का उपयोग करने पर विचार करें।
अपने प्रोजेक्ट के लिए एक स्वयं-व्याख्यात्मक नाम चुनें।
लोगों को बताएं कि आपका प्रोजेक्ट विशेष रूप से क्या कर सकता है। संदर्भ प्रदान करें और किसी भी ऐसे संदर्भ का लिंक जोड़ें जिससे आगंतुक अपरिचित हो सकते हैं। यहां Features या Background उप-अनुभाग की एक सूची भी जोड़ी जा सकती है। यदि आपके प्रोजेक्ट के विकल्प हैं, तो यह विभेदक कारकों को सूचीबद्ध करने के लिए एक अच्छी जगह है।
कुछ README में, आप छोटी छवियां देख सकते हैं जो मेटाडेटा बताती हैं, जैसे कि प्रोजेक्ट के सभी परीक्षण पास हो रहे हैं या नहीं। आप अपने README में कुछ जोड़ने के लिए Shields का उपयोग कर सकते हैं। कई सेवाओं में बैज जोड़ने के निर्देश भी होते हैं।
आप जो बना रहे हैं उसके आधार पर, स्क्रीनशॉट या यहां तक कि एक वीडियो शामिल करना एक अच्छा विचार हो सकता है (आप अक्सर वास्तविक वीडियो के बजाय GIF देखेंगे)। ttygif जैसे टूल्स मदद कर सकते हैं, लेकिन अधिक परिष्कृत विधि के लिए Asciinema देखें।
किसी विशेष पारिस्थितिकी तंत्र के भीतर, चीज़ों को इंस्टॉल करने का एक सामान्य तरीका हो सकता है, जैसे Yarn, NuGet, या Homebrew का उपयोग करना। हालांकि, इस संभावना पर विचार करें कि आपका README पढ़ने वाला कोई भी व्यक्ति नौसिखिया हो सकता है और अधिक मार्गदर्शन चाहता हो। विशिष्ट चरणों को सूचीबद्ध करने से अस्पष्टता दूर करने में मदद मिलती है और लोगों को जल्द से जल्द आपके प्रोजेक्ट का उपयोग करने में मदद मिलती है। यदि यह केवल एक विशिष्ट संदर्भ में चलता है जैसे कि कोई विशेष प्रोग्रामिंग भाषा संस्करण या ऑपरेटिंग सिस्टम या इसमें ऐसी निर्भरताएं हैं जिन्हें मैन्युअल रूप से इंस्टॉल करना होता है, तो Requirements उप-अनुभाग भी जोड़ें।
उदाहरणों का उदारतापूर्वक उपयोग करें, और यदि संभव हो तो अपेक्षित आउटपुट दिखाएं। उपयोग के सबसे छोटे उदाहरण को इनलाइन रखना मददगार होता है जिसे आप प्रदर्शित कर सकते हैं, साथ ही अधिक परिष्कृत उदाहरणों के लिंक प्रदान करना यदि वे README में यथोचित रूप से शामिल करने के लिए बहुत लंबे हों।
लोगों को बताएं कि वे मदद के लिए कहां जा सकते हैं। यह एक इश्यू ट्रैकर, एक चैट रूम, एक ईमेल पता, आदि का कोई भी संयोजन हो सकता है।
यदि आपके पास भविष्य में रिलीज़ के लिए विचार हैं, तो उन्हें README में सूचीबद्ध करना एक अच्छा विचार है।
बताएं कि क्या आप योगदान के लिए खुले हैं और उन्हें स्वीकार करने के लिए आपकी क्या आवश्यकताएं हैं।
जो लोग आपके प्रोजेक्ट में बदलाव करना चाहते हैं, उनके लिए शुरुआत करने का तरीका बताने वाला कुछ दस्तावेज़ होना मददगार होता है। हो सकता है कि उन्हें कोई स्क्रिप्ट चलानी हो या कुछ environment variables सेट करने हों। इन चरणों को स्पष्ट रूप से लिखें। ये निर्देश आपके भविष्य के स्वयं के लिए भी उपयोगी हो सकते हैं।
आप कोड को lint करने या टेस्ट चलाने के कमांड भी दस्तावेज़ित कर सकते हैं। ये चरण उच्च कोड गुणवत्ता सुनिश्चित करने में मदद करते हैं और इस संभावना को कम करते हैं कि बदलाव अनजाने में कुछ तोड़ दें। टेस्ट चलाने के निर्देश होना विशेष रूप से तब सहायक होता है जब इसके लिए बाहरी सेटअप की आवश्यकता हो, जैसे ब्राउज़र में परीक्षण के लिए Selenium सर्वर शुरू करना।
उन लोगों के प्रति अपना आभार व्यक्त करें जिन्होंने प्रोजेक्ट में योगदान दिया है।
ओपन सोर्स प्रोजेक्ट्स के लिए, बताएं कि यह किस लाइसेंस के अंतर्गत है।
यदि आपके पास अपने प्रोजेक्ट के लिए ऊर्जा या समय खत्म हो गया है, तो README के शीर्ष पर एक नोट डालें कि विकास धीमा हो गया है या पूरी तरह रुक गया है। कोई व्यक्ति आपके प्रोजेक्ट को fork करना चुन सकता है या maintainer या owner के रूप में आगे आने के लिए स्वेच्छा से कदम बढ़ा सकता है, जिससे आपका प्रोजेक्ट आगे चलता रहे। आप maintainers के लिए स्पष्ट अनुरोध भी कर सकते हैं।
हमारे समुदाय द्वारा सबसे अधिक उपयोग किए जाने वाले उपकरण खोजें।
अभी तक कोई लोकप्रियता डेटा नहीं है।