كيف أقوم بإعداد وتحميل مشروع موجود على GitHub؟

مكتمل

في هذه الوحدة، نناقش الاعتبارات المهمة لتحميل مشروع إلى GitHub.

لماذا يتم التحميل إلى GitHub؟

هناك مجلدات من الأدبيات التي تعجب فضائل GitHub، وهذا خارج نطاق هذه الوحدة النمطية لإقناعك بالانضمام. ومع ذلك، في هذه الوحدة النمطية نلخص بعض الفوائد الرئيسية في سياق الموضوعات التي تحتاج إلى مراعاتها عند التخطيط لتحميلك.

التحكم بالإصدار

يستخدم GitHub حصرياً Git، وهو ما يمكن القول بأنه أفضل نظام تحكم في الإصدار. ومع ذلك، فإن Git متطور بشكل لا يصدق ويمكنه إنشاء بعض السيناريوهات المعقدة للعمل مع التعليمات البرمجية التي قد لا يكون فريقك من ذوي الخبرة بها. إن الإصدارات الفرعيةوطلبات السحب أجزاء أساسية من الحياة اليومية للمطورين الذين يستخدمون Git، لذلك فمن الضروري فَهْم متى وكيف يتم استخدامها بفعالية لتحقيق النجاح في GitHub. من المفيد أن يتعلم فريقك أولاً عن تدفق GitHub ومن ثمّ يمكنك الانطلاق.

الاحتفاظ بالتعليمات البرمجية في السحابة

لا يزال يتم تخزين كمية كبيرة من التعليمات البرمجية للمشروع حصريا على أجهزة المطور. لكن عند التحميل إلى GitHub، فإنك تنقل التعليمات البرمجية إلى نظام GitHub الأساسي السحابي، حيث يمكن لأعضاء الفريق الوصول إليها بسهولة من أي مكان. يوفر هذا التغيير فرصة جيدة لمراجعة نهج فريقك في معرفة أنواع الملفات والبيانات التي تحتفظ بها في نظام التحكم بالإصدار. كأفضل ممارسة، يجب أن تفترض أن أي شيء تلتزم به في GitHub قد يتعرض للخطر. لذلك، تأكد من عدم تضمين بيانات حساسة، مثل مفاتيح API أو كلمات المرور أو الملفات الأخرى التي تحتوي على معلومات قابلة للمقارنة.

إشعار

يوفر GitHub مستودعات عامة وخاصة، بالإضافة إلى عناصر تحكم وصول متعدد المستويات لأجزاء مختلفة من المستودع. يتيح لك هذا التحكم في الأشخاص الذين يمكنهم رؤية مشروعاتك، وكذلك الإجراءات التي يمكن لمستخدم معين تنفيذها.

مساهمه

يقدم GitHub دعمًا ممتازًا للتعاون الجماعي من خلال توفير ميزات مثل مناقشة المشكلات، وطلبات السحب، ومراجعات التعليمات البرمجية. ومع ذلك، قد يختلف تدفق GitHub عن الممارسات التي اعتاد عليها فريقك حاليا. من الجيد التفكير في كيفية تكيف فريقك مع GitHub، وما إذا كان يجب عليك الاحتفاظ بأي عمليات موجودة أم لا.

إذا كان مشروعك مشروعًا مفتوح المصدر مسموحًا به للمساهمين الخارجيين، فلا يوجد خيار أفضل من GitHub لتحقيق أقصى قدر من هذه المزايا.

تحميل إلى GitHub

اعتبارات الخطة

إن أهم شيء يجب مراعاته قبل تنفيذ تحميلك إلى GitHub هو تحديد ما إذا كنت بحاجة إلى الاحتفاظ بأي شيء يتجاوز الحالة الحالية لمصدر البيانات أم لا. على سبيل المثال، قد تستخدم جدول بيانات أو برنامج لإدارة المشاريع لتعقب الأخطاء التي تخطط لإصلاحها. يختلف دعم ترحيل هذه العناصر حسب النظام الأساسي، وهو متاح بشكل عام من مشاريع المجتمع. لا تغطي هذه الوحدة النمطية ترحيل هذا النوع من البيانات.

معالجة الملفات الثنائية المخزنة حاليا في مشروعك

وكأفضل ممارسة، ينبغي أن تقتصر مستودعات GitHub على الملفات الضرورية لإنشاء المشاريع. تجنب تثبيت ملفات ثنائية كبيرة، مثل إنشاء الأدوات. الملفات الثنائية مثل جداول البيانات والعروض هي أكثر ملاءمة ليتم تتبعها على المداخل التي تفهم كيفية الخدمة وإنشاء الإصدار بشكل صحيح. إذا كنت بحاجة إلى إصدار ملفات ثنائية كبيرة، ففكر في استخدام ملحق Git LFS (تخزين الملفات الكبيرة).

إنشاء ملفات Git مهمة مثل .gitignore

يدعم Git ملفات .gitignore للمساعدة في فرض نُهج ملفات التحكم في الإصدار. تحدد هذه الملفات أنماط البحث المستخدمة لاستبعاد الملفات والمجلدات من تعقب عنصر التحكم في المصادر. يستبعد المثال التالي بشكل متكرر أي مجلدات تسمى Bin أو bin، ومحتوياتها، من تعقب التحكم بالمصادر.

[Bb]in/

معرفة المزيد عن تجاهل الملفات. تحقق أيضاً من مجموعة ملفات البدء .gitignore المقدمة لأنظمة أساسية مختلفة في مستودع gitignore.

هناك العديد من الملفات الأخرى التي تستخدم عادةً في مشروعات GitHub لشرح النُّهج المختلفة لمستهلكي ومساهمي المستودع. حتى لو كان مشروعك خاصًا ومقتصرًا على جمهور محدود، فإنه من المفيد توضيح هذه النُهج بشكل صريح. في حين أن أيا من هذه الملفات غير مطلوبة، يتم سرد بعض الملفات الشائعة هنا.

ملف	الغرض
README.md	الصفحة المُنتقل إليها للدليل. يتم عرض هذه الصفحة عند عرض دليلها على GitHub.
LICENSE.md	يحتوي هذا الملف على الترخيص الذي يتم توفير التعليمات البرمجية بموجبه.
CONTRIBUTING.md	توضح هذه المقالة الكيفية التي ينبغي أن يساهم بها المستخدمون في المشروع، مثل توقعات طلب السحب.
SECURITY.md	يشرح نهج الأمان للمشروع. يوفر هذا الملف إرشادات للمستخدمين الذين يرغبون في إرسال تعليمات برمجية حساسة متعلقة بالأمان أو ملاحظات لا ينبغي الكشف عنها بشكل عام قبل معالجتها.

تعرف على المزيد حول إعداد مشروعك للحصول على مساهمات سليمة.

تحميل مشروعك إلى GitHub

بمجرد إعداد المستودع الخاص بك للتحميل، قم بإنشاء مستودع على GitHub. بمجرد الإنشاء، انتقل إلى علامة التبويب Code في مستودع GitHub الخاص بك. توفر لك طريقة العرض هذه عدة طرق لتحميل التعليمات البرمجية للمشروع.

نوصي باستخدام عميل git أو أداة صديقة ل Git لتحميل المصدر الخاص بك. بدلا من ذلك، يمكنك تحميل ملفاتك يدويا باستخدام ارتباط إنشاء ملف جديد. على المدى الطويل، من المحتمل أن تجد أن استخدام عميل git هو أفضل طريقة لإدارة التغييرات والفروع والمزيد.

متابعة