تحسين العمل مع مشاريعك على GitHub: التعرف على مستودع قوالب Github

مرحبًا بالجميع، مجتمع JavaRush! سنتحدث اليوم عن المصدر المفتوح وما يلزم لإنشاء مشروع عالي الجودة بالإضافة إلى الكود المكتوب. من المهم أن تكتب منتجًا مفيدًا. ولكن ليس أقل أهمية هو التصميم الصحيح للمستودع (مستودع المشروع على GitHub). سيساعد هذا في تنفيذ نقطة رئيسية أخرى - ترويج المنتج. حتى لو كان المشروع رائعًا للغاية، ولكن إذا كان تصميمه سيئًا، ولم يتم وصفه على الأقل في الملف التمهيدي (يمكنك القراءة حول ماهية الملف التمهيدي هنا )، ولم تتم الإشارة إلى الترخيص، وما إلى ذلك، وما إلى ذلك، فسيكون هناك لا نجاح. إنه فقط لن يلاحظه أحد. وإذا لاحظ شخص ما، فلن يعرف كيفية التفاعل معه. هناك الكثير من الأشياء التي يجب ملؤها مرارًا وتكرارًا، وليس من السهل على المبرمج النسخ واللصق في كل مرة، ولهذا فقط، أصدر GitHub هذا الصيف ميزة Template Repository التي تساعد في ذلك. إذا جاز التعبير، لأتمتة عملية إنشاء مشاريع جديدة. اليوم سوف نفهم ما هو المستودع وما هو مستودع النماذج. سنصف ما يجب أن يكون في المشروع إلى جانب الكود، وما هي الأشياء التي تحتاج إلى التركيز عليها. لنقم بإنشاء مستودع قوالب من البداية وإضافة كل ما هو ضروري من وجهة نظري. وأخيرًا، سوف نستخدم مستودع النماذج عند إنشاء مستودع جديد. لكن أولاً، دعونا نفهم المصطلحات. النظرية: ما الذي يجب أن يكون في المستودع العام لأي مشروع؟ يجب أن يكون لكل مشروع مفتوح المصدر على GitHub ملف تعريف مجتمعي موصوف جيدًا ، والذي يحتوي على العناصر التالية.

1. نموذج الإصدار

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

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

يمكن رؤية مثال على ما يبدو عليه هنا .

2. الترخيص

الرخصة التي يتم بموجبها كتابة المشروع. ومن الضروري أن يعرف من سيستخدم المشروع ما هو مضمون وما هو غير مضمون. على سبيل المثال، ينص ترخيص Apache 2.0 على ما يلي:

3. التمهيدي

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

• نظرة عامة - وصف موجز للمشروع؛
• الاستخدام - كيفية استخدام المشروع؛
• البناء - كيفية إطلاق المشروع، ما هو المطلوب لذلك؛
• استكشاف الأخطاء وإصلاحها - يصف هذا المشكلات التي قد تواجهها وكيفية حلها؛
• ملاحظات الإصدار - وصف التغييرات حسب الإصدار؛
• المؤلفون - لا تنسوا أحبائكم؛
• المساهمة - وصف لكيفية المشاركة في تطوير المشروع؛
• قواعد السلوك - وصف قواعد المشاركة؛
• RELEASE_NOTES - ملف يتم فيه تسجيل كافة التغييرات للإصدارات الجديدة. من الممارسات الجيدة وضع هذا في مستند منفصل وتخزين رابط في ملف README؛
• المساهمة هو ملف يصف كيف يمكنك المساهمة في تطوير هذا المشروع. تم إنشاؤه كملف منفصل لرأس المساهمة في ملف README؛
• CODE_OF_CONDUCT - ملف يصف قواعد المشاركة في تطوير المشروع؛
• قالب طلب السحب - قالب لأولئك الذين سيقومون بإنشاء طلب سحب.

يتم استخدام كل هذه الأشياء من مشروع لآخر، بغض النظر عن لغة البرمجة أو تفاصيلها.

الممارسة: إنشاء القالب الخاص بك

كما يقولون، دعنا ننتقل من الأقوال إلى الأفعال. الآن، باستخدام مثال، سأوضح لك كيفية إنشاء القالب الخاص بك.

1. أول شيء تحتاجه هو حساب على GitHub / التسجيل هناك .

2. إنشاء مستودع جديد: للقيام بذلك، انقر فوق + في الزاوية اليمنى العليا

3. عند الإنشاء قم بملء:

   • اسم المستودع - في حالتي repository-template؛
   • الوصف — وصف موجز للمشروع؛
   • نترك العام، على الرغم من أنه يمكنك تحديد خاص؛
   • حدد مربع تهيئة README:

   • قم باختيار الترخيص الذي سيكون المشروع بموجبه:

     نظرًا لأن القالب في حالتي عام، فليس هناك حاجة إلى gitignore: ستتم إضافته لمشروع معين ولغة برمجة معينة.

     لذلك، انقر فوق "إنشاء مستودع" ، وبذلك تكتمل عملية الإنشاء. سينقلنا النظام تلقائيًا إلى المستودع الذي تم إنشاؤه حديثًا.

4. ملء ملف تعريف المجتمع : في المستودع الذي تم إنشاؤه، انتقل إلى علامة التبويب Insights وحدد المجتمع :

   كما ترون، كل ما تبقى هو ملء قواعد السلوك، والمساهمة، ونموذج المشكلة، ونموذج طلب السحب.

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

   انقر فوق إضافة ، وسيطالبك النظام بتحديد ميثاق المساهم أو قواعد سلوك المواطن :

   قمت باختيار الخيار الأول ثم انقر فوق مراجعة وإرسال .

   وبعد ذلك، يمكنك تحرير هذا الملف وتنفيذه.

   في الأسفل، حدد خيار الالتزام مباشرة بالفرع الرئيسي وانقر فوق إرسال ملف جديد :

   ونتيجة لذلك، إذا عدنا إلى ملف تعريف المجتمع ، فسنجد أن قواعد السلوك تم وضع علامة عليها كمضافة:

   تتم إضافة نموذج المساهمة والإصدار بطريقة مماثلة، لذلك لن أعرض هذا. افعلها بنفسك ؛)

5. إضافة قالب طلب السحب .

   لكننا سنتحدث عن هذا بشكل منفصل.

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

   للقيام بذلك، انقر فوق إنشاء ملف جديد في جذر المستودع :

   يجب أن يكون اسم الملف: .github/pull_request_template.md .

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

   بهذه الطريقة سيتم ملء ملف تعريف المجتمع بالكامل:

6. قم بإضافة علامة مستودع النماذج .

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

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

كيفية استخدام مستودع النماذج

هناك خياران للاستخدام:

1. عندما يكون القالب مملوكًا لك مباشرةً: عند إنشاء مستودع جديد، سيتم منحك خيار الإنشاء من قالب من قائمة القوالب التي تمتلكها:

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

دعونا نلخص ذلك

في هذه المقالة نظرنا إلى:

• ما هو مستودع جيثب؟
• ما هو مستودع القوالب؟
• ما ينبغي أن يكون في مستودع النماذج؛
• كيفية إنشاء مستودع النماذج؛
• كيفية استخدام مستودع النماذج.

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

روابط مفيدة

• التنظيم مع جميع القوالب التي قمت بإنشائها
• مدونة GitHub: إنشاء مستودع جديد باستخدام قوالب المستودع كيفية إنشاء قالب للمستودعات
• مساعدة GitHub: حول المستودعات حول ماهية المستودعات.
• مساعدة GitHub: إنشاء مستودع من قالب كيفية إنشاء مشروع جديد بناءً على القالب
• مساعدة GitHub: الترخيص (وصف المستودع ) لترخيص المشاريع
• مساعدة GitHub: قم بإنشاء وصف الريبو لإنشاء مستودع
• نصائح أدلة المصدر المفتوح لإنشاء/وصف المشاريع مفتوحة المصدر.
• مساعدة GitHub: إضافة قالب طلب السحب - إنشاء قالب لطلبات السحب.

المزيد من مقالاتي

• تصحيح الأخطاء في Intellij IDEA: دليل للمبتدئين
• دليل لإنشاء عميل لـ Skyscanner API ونشره في jCenter وMaven Central [الجزء الأول]
• دليل لإنشاء عميل لـ Skyscanner API ونشره في jCenter وMaven Central [الجزء 2]
• إنشاء نظام لمراقبة أسعار تذاكر الطيران: دليل خطوة بخطوة [الجزء الأول]
• إنشاء نظام لمراقبة أسعار تذاكر الطيران: دليل خطوة بخطوة [الجزء الثاني]
• إنشاء نظام لمراقبة أسعار تذاكر الطيران: دليل خطوة بخطوة [الجزء 3]
• التسجيل: ماذا وكيف وأين وبماذا؟
• كيف تحول اختبار المقابلة إلى مكتبة مفتوحة المصدر
• تاريخ النجاح. 20 ساعة من البرمجة أسبوعيًا ودرجة الماجستير والحياة الشخصية
• كيفية العثور على وظيفة؟ نصائح لإرسال السيرة الذاتية