cryptoadvocate/cryptohackappالمنزل الهندسي للهواتف المحمولة لمشروع Cryptohack Badge.
لتسهيل البدء مع GitLab، فيما يلي قائمة بالخطوات التالية الموصى بها.
هل أنت محترف بالفعل؟ فقط قم بتعديل ملف README.md هذا واجعله خاصًا بك. هل تريد جعله سهلاً؟ استخدم القالب في الأسفل!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/cryptohackapp.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 تفيد بأن التطوير تباطأ أو توقف تمامًا. قد يختار شخص ما تفريع مشروعك أو التطوع للدخول كمشرف أو مالك، مما يسمح لمشروعك بالاستمرار. يمكنك أيضًا تقديم طلب صريح للمشرفين.