zzugab/juice-shop-with-kubeadm-and-tfنشر آلي لمتجر OWASP Juice Shop على Kubernetes باستخدام kubeadm وTerraform، مع فحص الثغرات المدمج Trivy لخطوط أنابيب DevSecOps.
لتسهيل البدء مع GitLab، إليك قائمة بالخطوات التالية الموصى بها.
هل أنت محترف بالفعل؟ فقط قم بتعديل هذا الملف README.md واجعله خاصًا بك. هل تريد التسهيل؟ استخدم القالب في الأسفل!
cd existing_repo
git remote add origin https://gitlab.com/zzugab/juice-shop-with-kubeadm-and-tf.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 تفيد بأن التطوير قد تباطأ أو توقف تمامًا. قد يختار شخص ما تفريع مشروعك أو التطوع للانضمام كمشرف أو مالك، مما يسمح لمشروعك بالاستمرار. يمكنك أيضًا تقديم طلب صريح للمشرفين.