إعلان: أترغب في أن تكون مشرفاً في هذا المشروع وتعين على إستمراريته؟ إن كنت مهتما أرسل لي رسالة خاصة على Twitter واقرأ دليل المشرفين.
هذا دليل تعليمي لمساعدة المساهمين لأول مرة للمشاركة في مشروع سهل وبسيط.
هذا الدليل متوفر أيضاً بلغات أخرى (البرتغالية, الإسبانية, و الإيطالية في الوقت الحالي. نرحب بالترجمات).
- المساهمة في مشروع مفتوح المصدر.
- الإعتياد على التعامل مع GitHub.
- هذا الدليل للمبتدئين جداً. إن كنت تعرف كيف تكتب وتعدل على وسم الروابط
<a href="" target=""></a>
فيمكنك فعلها. - إنه لأولئك الذين لديهم القليل من الخبرة ويرغبون في تسجيل أول مساهمة لهم في المصدر المفتوح، أو تسجيل مساهمات أكثر للمزيد من الخبرة أو لاكتساب الثقة.
أي مبرمج ويب صاعد أو خبير يحتاج لاستخدام نظام إصدارات قيت (git version control)، و GitHub هو خدمة الإستضافة الأشهر لمشاريع Git والذي يستخدمه الجميع. هو كذلك القلب النابض لمجتمع المصدر المفتوح. الإعتياد على استعمال GitHub مهارة لا غنى عنها. المساهمة في مشروع مفتوح المصدر يعطيك دفعة من الثقة ومادة يمكنك عرضها على صفحتك الشخصية على GitHub.
إن كنت مبرمجاً جديداً وتتسائل إن كان يجب عليك أن تتعلم Git و GitHub ففي المقال التالي تجد الإجابة: You Should've Learned Git Yesterday.
سوف تساهم بكرت كهذا تماماً على صفحة الويب لهذا المشروع. سيحتوي الكرت على اسمك، معرف تويتر الخاص بك، وصف مختصر، و 3 روابط لمصادر من ترشيحك لمطوري الويب.
ستقوم بعمل نسخة من كود الكرت داخل ملف ال HTML وتخصيصه بعلوماتك الخاصة.
في البداية، لنتجهز لبدء العمل
- سجل الدخول لحسابك على GitHub. إن لم تقم بعد بإنشاء حساب فقم بالإنضمام. أنصحك باتباع دليل البداية من GitHub قبل الإستمرار.
- قم بتحميل GitHub لسطح المكتب.
- كخيار آخر، إن كنت ترتاح لاستخدام Git على ال command line فيمكنك استخدامه (هنا تجد المساهمين لأول مرة, مشروعاً مشابهاً يمكن أن يكون دليلاً للأوامر المطلوبة.) وكخيار ثالث...
- إن كنت تستخدم محرر VS Code فهو يأتي مع نظام Git مدمجاً ويسمح لك بتنفيذ ما نريده مباشرة من داخل البرنامج.
- وعلى كل حال، الطريقة الأبسط لاتباع هذا الدليل هي استخدام GitHub لسطح المكتب.
الآن وقد تجهزت، لنبدأ عملية المساهمة في هذا المشروع.
تحول لمساهم في المصدر المفتوح عبر 10 خطوات بسيطة.
الوقت المقدر: أقل من 30 دقيقة.
- الهدف هنا هو عمل نسخة من هذا المشروع ووضعها في حسابك الشخصي.
- المستودع (repo) هو الإسم الذي يطلق على أي مشروع في GitHub وال fork هي نسخة منه.
- تأكد من أنك في الصفحة الرئيسية لهذا المشروع.
|
---|
- لديك الآن نسخة كاملة من المشروع على حسابك الخاص.
- الآن نريد عمل نسخة محلية من المشروع. هذا يعني نسخة من المشروع محفوظة على جهازك الشخصي.
- افتح تطبيق GitHub لسطح المكتب. في التطبيق:
|
---|
|
|
---|---|
|
- سيستغرق الأمر بعض الوقت ريثما يتم نسخ المشروع إلى القرص الخاص بك. أنصحك بترك المسار الافتراضي كما هو والذي هو عادة
..\Documents\GitHub
. - الآن لديك نسخة محلية من المشروع.
- بمجرد أن أنشأت نسخة من المستودع وفمت بفتحها على تطبيق GitHub لسطح المكتب فقد حان وقت إنشاء تفرع جديد (branch).
- التفرع (branch) هي وسيلة لفصل تغييراتك عن المشروع الأساسي المسمى
Master
. على سبيل المثال إن لم تسر الأمور على ما يرام ولست سعيداً بالتغييرات التي قمت بها فيمكنك ببساطة حذف التفرع من دون أن تؤثر على المشروع الأساسي.
|
---|
|
---|
- يمكنك تسمية التفرع ما تشاء، لكن بما أن الغرض من هذا التفرع هو إضافة كرت بإسمك إلى المشروع، فتسمية التفرع بـ
your-name-card
على سبيل المثال خيار جيد، فهو يجعل الغرض من التفرع واضحاً من خلال الإسم.
|
---|
- الآن لقد قمت بإنشاء تفرع جديد منفصل من التفرع الأصل
Master
. - خلال الخطوات القادمة تأكد أنك تعمل على هذا التفرع. سترى اسم التفرع الحالي في وسط الجزء العلوي من تطبيق GitHub لسطح المكتب حيث تقول Current branch.
إياك أن تعمل على تفرع Master
- الآن علينا فتح الملف الذي سنقوم بتعديله بواسطة محرر الأكواد المفضل لدينا.
- جد مجلد المشروع على جهازك. إن كنت حافظت على المسار الافتراضي فسيكون نحو التالي
your-computer > Documents > GitHub > Contribute-To-This-Project
- ملف
index.html
يوجد مباشرة داخل مجلدContribute-To-This-Project
.
- الآن لديك الملف والذي ستقوم بتحريره على محرر الأكواد وأنت جاهز لبدء التعديل عليه.
- سنقوم بعمل نسخة من كود الكرت لبدء العمل عليه.
|
---|
- الآن هذا هو كرتك الخاص لتقوم بتخصيصه وتعديله.
- سنقوم الآن ببدء تعديل كود ال html، بتغيير الخانات المخصصة على الكرت الخاص بنا.
|
---|
|
---|
- إذا كنت ترغب باستخدام وسيلة تواصل غير تويتر فعليك استبدال الأيقونة
<i class="fa fa-twitter"></i>
بالذهاب إلى Font Awesome Icons والبحث عن الأيقونة المناسبة ثم فقط استبدال جزئيةfa-twitter
بالأيقونة الجديدة مثلfa-facebook
على سبيل المثال. ثم اتبع نفس الخطوات بالأعلى.
|
---|
- تأكد من قيامك بحفظ جميع تعديلاتك.
- اختبر تعديلاتك. هذا في غاية الأهمية! افتح ملف ال html في المتصفح الخاص بك (بالضغط عليه لمرتين مثلاً) وانظر كيف سيبدو شكل الكرت الخاص بك على الموقع. تحقق من أن الصفحة بالكامل تبدو كما كانت عليه ولا شئ يبدو خطأً. اضفط على الروابط الخاصة بك وتأكد من أنها تعمل. افتح ال console (Ctrl + Shift + J) (ويندوز \ لينكس) أو Cmd + Opt + J على الماك)) وتحقق من أنه لا توجد رسائل خطأ.
- ممتاز، لقد قمت بإنهاء تعديلاتك على الكود! الخطوات التالية سترسل تغييراتك إلى GitHub وثم ستفوم بتقديم طلب لدمجها في المشروع الأساسي.
- عد إلى تطبيق GihHub لسطح المكتب.
- ستكون تعديلاتك قد ظهرت تلقائياً في منطفة staging.
- هذا يعني أن GitHub قد قام بتسجيل التغييرات المحفوظة.
- يمكنك مشاهدة ذلك في التطبيق. أي شئ قمت بإضافته للملف سيبدو باللون الأخضر، وعمليات الحذف ستظهر باللون الأحمر.
|
---|
Current branch أو التفرع الحالي سيحمل نفس الإسم الذي أعطيته إياه في الخطوة رقم 3 |
---|
- تعديلاتك الآن محفوظة أو مؤكدة (committed). لكنها محفوظة فقط محليا على جهازك الشخصي.
- عملية مزامنة تغييراتك المحلية مغ المستودع على Github تسمى Push. فأنت تدفع التغييرات من جهازك الشخصي إلى المستودع البعيد على Github.
|
---|
- After a few seconds the operation is complete and now you have exactly the same copy of this branch on your machine as well as on GitHub.
- بعد عدة ثواني ستكتمل العملية. والآن لديك نسخة طبق الأصل من هذا التفرع على جهازك وكذلك على GitHub.
- هذه هي اللحظة التي كنت بانتظارها، تقديم طلب Pull Request (PR).
- حتى الآن قل العمل الذي قمت به كان على النسخة (fork) من هذا المشروع. والذي كما تذكر موجود تحت حسابك الشخصي على GitHub.
- الآن حان وقت إرسال تغييراتك إلى المشروع الرئيسي ليتم دمجها.
- هذه العملية تسمى طلب Pull Request لأنك تطلب من المشرف على المشروع الأصلي أن يسحب (pull) تعديلاتك إلى المشروع الأساسي.
- إذهب إلى الصفحة الرئيسية لنسختك (fork) على GitHub (ستحتوي على أيقونة النسخ واسم المستخدم الخاص بك في الأعلى).
- في اتجاه الجزء العلوي من المستودع ستجد رسالة مظللة لعملية pull request مع زر أخضر اللون.
|
---|
|
---|
- لا ترتبك من كمية الخيارات. ستحتاج فقط لهذه الخطوات الثلاث في الوقت الحالي.
- أترك خيار
Allow edits from maintainers
مصححاً. - والآن، سيتم إرسال Pull Request إلى المشرف على المشروع. بمجرد ما أن يتم مراجعته والموافقة عليه ستظهر تغييراتك على صفحة الويب للمشروع.
لقد فعلتها! أنت الآن قد شاركت في المصدر المفتوع على GitHub.
لقد قمت بإضافة كود لصفحة ويب نشطة: https://syknapse.github.io/Contribute-To-This-Project
تغييراتك لن تكون لن تكون متاحة مباشرة؛ عليها أولاً أن تخضع للمراجعة، الموافقة، ثم الدمج عن طريق مشرف المشروع. بمجرد أن يتم الدمج سيظهر الكرت الخاص بك على الصفحة.
من الطبيعي جداً أن يطلب منك المراجع تغييرات على ال PR. فكر بها بشكل حميد ان تعرضت لذلك. أبق عينك مفتوحة لأي تعليق أو طلبات بالتغيير. بمجرد أن تقوم بالتغييرات المطلوبة (في تفرعك الخاص) كل ما عليك فعله هو تأكيد (commit) ودفع تغييراتك. سيتم تحديث ال PR مباشرة بالتغييرات الجديدة.
أعدك أني سأحاول المراجعة والدمج بأسرع ما يمكنني، لكني أقوم بذلك في وقت فراغي، لذا فلا مفر من التأخر لعدة أيام.
- عد بعد مدة قصيرة لتراحع عمليه دمج ال PR الخاص بك.
- ستستلم بريداً إلكترونياً من GitHub عندما يتم الموافقة على تعديلاتك، أو في حالة تم طلب بعض التغييرات، وأيضاً عندما يتم أخيراً الموافقة على ال PR الخاص بك إلى تفرع ماستر وإضافة الكرت الخاص بك.
- إن كنت تجد هذا المشروع مفيداً فقم بإضافة ⭐ نجمة ⭐ في أعلى الصفحة و قم بالتغريد عنها لنشرها
- يمكنك أن تتابعني والتواصل معي على تويتر أو أياً من الخيارات الأخرى هنا
- هذا المشروع مفتوح المصدر، لذا فبالإضافة للمساهمة بالكرت الخاص بك فأنت مرحب بك لإصلاح أي ثغرات، التطوير، أو إضافة مزايا جديدة. قم بفتح issue أو قدم pull request جديداً
هذا المشروع متأثر بشكل كبير بالمشروع العظيم first-contributions لصاحبه Roshan Jossey مع دليله الممتاز.
هو كذلك مستوحى من المجتمع العظيم حول #GoogleUdacityScholars منحة تحدي قوقل: مطور واجهات الويب، فصل عام 2017 بأوروبا.