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