valtersit/wordpress-cve-scannerافحص نواة ووردبريس والقوالب والإضافات الخاصة بك بحثًا عن ثغرات CVE المعروفة من سطر الأوامر. مفتوح المصدر، قابل للتدقيق، الخصوصية أولًا — مدعوم بواسطة ValtersIT CVE API.
لتسهيل بدء العمل مع GitLab، إليك قائمة بالخطوات التالية الموصى بها.
هل أنت محترف بالفعل؟ ما عليك سوى تعديل ملف README.md هذا واجعله خاصًا بك. تريد أن يكون الأمر سهلاً؟ استخدم القالب الموجود في الأسفل!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/wordpress-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 تقول إن التطوير قد تباطأ أو توقف تمامًا. قد يختار شخص ما عمل نسخة متفرعة من مشروعك أو يتطوع للانضمام كمشرف أو مالك، مما يسمح لمشروعك بالاستمرار. يمكنك أيضًا تقديم طلب صريح للمشرفين.