
افحص تطبيقات Ruby/Rails عبر Gemfile.lock — يطابق الحزم (gems) مع قاعدة بيانات ValtersIT CVE
لتسهيل بدء العمل مع GitLab، إليك قائمة بالخطوات التالية الموصى بها.
هل أنت محترف بالفعل؟ ما عليك سوى تحرير ملف README.md هذا وجعله خاصًا بك. هل تريد تسهيل الأمر؟ استخدم القالب الموجود في الأسفل!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/ruby-cve-scanner.git
git branch -M main
git push -uf origin main
استخدم التكامل المستمر المدمج في GitLab.
عندما تصبح جاهزًا لجعل ملف README هذا خاصًا بك، ما عليك سوى تحرير هذا الملف واستخدام القالب المفيد أدناه (أو لا تتردد في هيكلته كما تشاء - فهذه مجرد نقطة انطلاق!). شكرًا لـ makeareadme.com على هذا القالب.
كل مشروع مختلف، لذا فكّر في أي من هذه الأقسام ينطبق على مشروعك. الأقسام المستخدمة في القالب هي اقتراحات لمعظم المشاريع مفتوحة المصدر. ضع في اعتبارك أيضًا أنه رغم أن ملف README قد يكون طويلًا ومفصّلًا أكثر من اللازم، فإن الطويل أفضل من القصير. إذا كنت تعتقد أن ملف README الخاص بك طويل جدًا، ففكّر في استخدام شكل آخر من التوثيق بدلًا من حذف المعلومات.
اختر اسمًا واضحًا يشرح نفسه لمشروعك.
أخبر الناس بما يمكن لمشروعك فعله على وجه التحديد. وفّر سياقًا وأضف رابطًا لأي مرجع قد لا يكون الزوار على دراية به. يمكن أيضًا إضافة قائمة بالميزات أو قسم فرعي للخلفية هنا. إذا كانت هناك بدائل لمشروعك، فهذا مكان جيد لسرد العوامل المميزة.
في بعض ملفات README، قد ترى صورًا صغيرة تنقل بيانات وصفية، مثل ما إذا كانت جميع الاختبارات ناجحة للمشروع أم لا. يمكنك استخدام Shields لإضافة بعضها إلى ملف README الخاص بك. كما تحتوي العديد من الخدمات على تعليمات لإضافة شارة.
اعتمادًا على ما تصنعه، قد تكون فكرة جيدة تضمين لقطات شاشة أو حتى فيديو (سترى غالبًا صور GIF بدلًا من مقاطع الفيديو الفعلية). يمكن لأدوات مثل ttygif المساعدة، لكن اطّلع على Asciinema للحصول على طريقة أكثر تطورًا.
داخل نظام بيئي معين، قد تكون هناك طريقة شائعة لتثبيت الأشياء، مثل استخدام Yarn أو NuGet أو Homebrew. ومع ذلك، ضع في اعتبارك احتمال أن يكون من يقرأ ملف README الخاص بك مبتدئًا ويرغب في مزيد من الإرشاد. يساعد سرد خطوات محددة في إزالة الغموض ويجعل الناس يستخدمون مشروعك بأسرع ما يمكن. إذا كان يعمل فقط في سياق معين مثل إصدار لغة برمجة معينة أو نظام تشغيل معين أو لديه تبعيات يجب تثبيتها يدويًا، فأضف أيضًا قسمًا فرعيًا للمتطلبات.
استخدم الأمثلة بسخاء، واعرض المخرجات المتوقعة إن أمكن. من المفيد تضمين أصغر مثال للاستخدام يمكنك توضيحه، مع توفير روابط لأمثلة أكثر تطورًا إذا كانت طويلة جدًا بحيث لا يمكن تضمينها بشكل معقول في ملف README.
أخبر الناس إلى أين يمكنهم اللجوء للحصول على المساعدة. يمكن أن يكون أي مزيج من متتبع المشكلات أو غرفة دردشة أو عنوان بريد إلكتروني، إلخ.
إذا كانت لديك أفكار لإصدارات مستقبلية، فمن الجيد سردها في ملف README.
وضّح ما إذا كنت منفتحًا على المساهمات وما هي متطلباتك لقبولها.
بالنسبة للأشخاص الذين يرغبون في إجراء تغييرات على مشروعك، من المفيد توفّر بعض الوثائق حول كيفية البدء. ربما توجد سكربت يجب عليهم تشغيله أو بعض متغيرات البيئة التي يحتاجون إلى ضبطها. اجعل هذه الخطوات واضحة. قد تكون هذه التعليمات مفيدة أيضًا لك في المستقبل.
يمكنك أيضًا توثيق الأوامر الخاصة بفحص الكود أو تشغيل الاختبارات. تساعد هذه الخطوات على ضمان جودة عالية للكود وتقليل احتمالية أن تؤدي التغييرات إلى كسر شيء ما عن غير قصد. يكون توفّر تعليمات لتشغيل الاختبارات مفيدًا بشكل خاص إذا كانت تتطلب إعدادًا خارجيًا، مثل تشغيل خادم Selenium للاختبار في متصفح.
أعرب عن تقديرك لمن ساهموا في المشروع.
بالنسبة للمشاريع مفتوحة المصدر، اذكر كيفية ترخيصها.
إذا نفدت طاقتك أو وقتك لمشروعك، فضع ملاحظة في أعلى ملف README تفيد بأن التطوير قد تباطأ أو توقف تمامًا. قد يختار شخص ما عمل fork لمشروعك أو يتطوع للانضمام كمشرف أو مالك، مما يسمح لمشروعك بالاستمرار. يمكنك أيضًا تقديم طلب صريح للمشرفين.