كيف تقوم بكتابة ملف إقراني رائع لمشروعك على Github

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

ملف إقراني

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

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

  • ماهو مهمة ودور مشروعك
  • كيفية تثبيته
  • مثال عن الإستعمال
  • كيفية إعداد بيئة التطوير
  • الترخيص ومعلومات عن المطور

سنقوم بشرح كل واحدة على حدى وفي أخر الموضوع سنزودك بقالب لملف إقراني يمكنك إستعماله في مشروعك.

ماهو مهمة ودور مشروعك:

 إن المستخدمين المحتملين لمشروعك يجب أن يكونوا قادرين على تحديد وبسرعة الغرض من مشروعك فأحرص على توفير هذه المعلومة في أول الملف والطريقة الأمثل لعمل ذلك هي بتوفير مايلي :

  •  فقرة واحدة مختصرة تصف فيها المشروع الخاص بك
  • لقطة تمثيلية، ومن الأفضل توفير ملف GIF وهذا سيقوم بتعريف مشروعك بالحركة

كيفية تثبيته:

 إذا أعجب المستخدمين بمشروعك سيريدون تعلم كيفية إستخدامه وربما ستكون كيفية إستخدامه أو تثبينه سهلة بالنسبة لك إلا أن المستخدمين سيصابون بالإحباط إذا لم تضع لهم التعليمات اللازم إتباعها للقيام بعملية التثبيت و طبعا سيبتعدون عن مشروعك خاصة إذا كان معقد لذلك عليك جعل هذه الخطوة بسيطة للغاية والطريقة الصحيحة لفعل ذلك :

وجود كتلة برمجية في ملف إقراني لتظهر لهم بالضبط ماعليهم كتابته في الشيل لتثبيت مشروعك وأكيد يجب ان يكون ذلك على جميع المنصات التي يدعمها هذا الأخير خاصة إذا كان هناك فرق في عملية التثبيت في كل من (OS X/Linux/Windows).

مثال عن الإستعمال:

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

كيفية إعداد بيئة التطوير :

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

  • كيفية تثبيت بيئة التطوير
  •  تشغيل مثال ما للإختبار.

الترخيص ومعلومات عن المطور :

إن توفير الرخص ومعلومات الإتصال مهم لتوضيح الوضع القانوني لمشروعك، وموقع github يقترح إنشاء ملف نصي للرخص ووضعه على دليل المستودع الرئيسي وعلى الرغم من وجود هذه الإتفاقية فإنه من الجيد أيضا وضع قسم مختصر على ملف إقراني بالمعلومات التالية :

  • معلومات الإتصال للمطور مثل صفحتك على تويتر أو عنوانك الإلكتروني
  • بيان سريع عن الرخصة .

قالب مجاني لملف README.md لقراء بايثون العربي 

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

يمكن تحميل الملف على الرابط التالي : https://github.com/kader14/readme

 

أرجوا أن تقوم بدعمنا عبر نشرك والاعجاب بالموقع

اترك تعليقاً

لن يتم نشر عنوان بريدك الإلكتروني. الحقول الإلزامية مشار إليها بـ *

Post Navigation