بهینه سازی کار با پروژه های خود در GitHub: آشنایی با مخزن قالب Github

سلام به همه، انجمن JavaRush! امروز ما در مورد منبع باز و آنچه که برای ایجاد یک پروژه با کیفیت بالا لازم است علاوه بر کد نوشته شده صحبت خواهیم کرد. نوشتن یک محصول مفید مهم است. اما طراحی صحیح مخزن (مخزن پروژه در GitHub) از اهمیت کمتری برخوردار نیست. این به اجرای یک نکته کلیدی دیگر - تبلیغ محصول کمک می کند. حتی اگر پروژه فوق العاده جالب باشد، اما اگر طراحی ضعیفی داشته باشد، حداقل در README توضیح داده نشده است (شما می توانید در مورد README در اینجا بخوانید )، مجوز نشان داده نشده است، و غیره، و غیره، وجود خواهد داشت. بدون موفقیت. فقط این است که هیچ کس متوجه او نخواهد شد. و اگر کسی متوجه شود، نمی داند چگونه با او تعامل کند. موارد زیادی وجود دارد که باید بارها و بارها پر شوند، و کپی و پیست کردن هر بار برای برنامه نویس آسان نیست، و فقط برای این، تابستان امسال، GitHub ویژگی Template Repository را منتشر کرد که به این امر کمک می کند. بنابراین، برای خودکار کردن فرآیند ایجاد پروژه های جدید. امروز خواهیم فهمید که مخزن چیست و مخزن قالب چیست. ما توضیح خواهیم داد که در پروژه علاوه بر کد، چه چیزهایی باید تمرکز کنید. بیایید یک مخزن قالب از ابتدا ایجاد کنیم و هر چیزی که از دیدگاه من لازم است را اضافه کنیم. و در نهایت، هنگام ایجاد یک مخزن جدید، از Repository قالب استفاده خواهیم کرد. اما ابتدا اجازه دهید شرایط را درک کنیم. تئوری: آنچه باید در مخزن کلی هر پروژه باشد هر پروژه منبع باز در GitHub باید دارای یک نمایه جامعه به خوبی توصیف شده باشد که حاوی عناصر زیر است.

1. قالب شماره

در اینجا باید قوانین ایجاد یک موضوع در مخزن را شرح دهید: آنها چه نامیده می شوند، چه برچسبی خواهد بود، چه کسی به آن اختصاص داده می شود. هنگام ایجاد یک شماره جدید، گزینه های زیر ارائه می شود:

• گزارش اشکال - ایجاد یک مشکل برای توصیف نقص در پروژه.
• درخواست ویژگی - پیشنهاد یک ایده جدید برای یک پروژه.
• درخواست بهبود - پیشنهاد برای بهبود پروژه؛
• قالب شماره سفارشی - اگر گزینه های دیگر کار نمی کنند، می توانید از یک الگوی خالی استفاده کنید.

نمونه ای از این که به نظر می رسد را می توان در اینجا مشاهده کرد .

2. مجوز

مجوزی که پروژه تحت آن نوشته شده است. لازم است تا کسانی که از پروژه استفاده می کنند بدانند چه چیزی تضمین شده است و چه چیزی نیست. به عنوان مثال، مجوز Apache 2.0 موارد زیر را می گوید:

3.README

این توضیحات پروژه، کارت تلفن آن است. هر چیزی که باید در مورد پروژه گفته شود باید در اینجا باشد. البته لازم است هر بار با در نظر گرفتن مشخصات پروژه توضیح داده شود، اما سرفصل ها یکسان خواهد بود. مثلا:

• نمای کلی - شرح مختصری از پروژه؛
• استفاده - نحوه استفاده از پروژه؛
• ساختمان - نحوه راه اندازی یک پروژه، آنچه برای این مورد نیاز است.
• عیب یابی - این توضیح می دهد که با چه مشکلاتی ممکن است مواجه شوید و چگونه آنها را حل کنید.
• یادداشت های انتشار - شرح تغییرات بسته به نسخه.
• نویسندگان - عزیزان خود را فراموش نکنید.
• مشارکت - شرح نحوه مشارکت شما در توسعه پروژه؛
• کد رفتار - شرح قوانین مشارکت؛
• RELEASE_NOTES - فایلی که تمام تغییرات نسخه های جدید در آن ثبت می شود. این یک تمرین خوب است که این را در یک سند جداگانه قرار دهید و یک پیوند را در README ذخیره کنید.
• CONTRIBUTING فایلی است که نحوه مشارکت شما در توسعه این پروژه را توضیح می دهد. به عنوان یک فایل جداگانه برای هدر Contributing در README ساخته شده است.
• CODE_OF_CONDUCT - فایلی که قوانین مشارکت در توسعه پروژه را شرح می دهد.
• الگوی درخواست کشش - الگویی برای کسانی که درخواست کشش ایجاد می کنند.

همه این موارد بدون توجه به زبان برنامه نویسی یا مشخصات آن از پروژه ای به پروژه دیگر استفاده می شود.

تمرین: ایجاد الگوی خود

همانطور که می گویند، از حرف به عمل برویم. اکنون، با استفاده از یک مثال، به شما نشان خواهم داد که چگونه قالب خود را بسازید.

1. اولین چیزی که نیاز دارید یک حساب کاربری در GitHub است / در آنجا ثبت نام کنید .

2. یک مخزن جدید ایجاد کنید: برای انجام این کار، روی + در گوشه سمت راست بالا کلیک کنید

3. هنگام ایجاد، پر کنید:

   • نام مخزن - در مورد من repository-template.
   • توضیحات - شرح مختصری از پروژه؛
   • ما عمومی را ترک می کنیم، اگرچه می توانید خصوصی را انتخاب کنید.
   • کادر اولیه سازی README را علامت بزنید:

   • مجوزی که پروژه تحت آن خواهد بود را انتخاب کنید:

     از آنجایی که در مورد من قالب کلی است، gitignore مورد نیاز نیست: برای یک پروژه خاص و زبان برنامه نویسی اضافه خواهد شد.

     بنابراین، روی Create Repository کلیک کنید و بدین ترتیب فرآیند ایجاد کامل می شود. سیستم به طور خودکار ما را به مخزن تازه ایجاد شده می برد.

4. پر کردن نمایه انجمن : در مخزن ایجاد شده، به برگه Insights بروید و انجمن را انتخاب کنید :

   همانطور که می بینید، تنها چیزی که باقی می ماند این است که الگوی کد رفتار، مشارکت، صدور الگو، الگوی درخواست کشش را پر کنید.

   با استفاده از مثال کد رفتار، نحوه اضافه کردن آنها را به یک پروژه نشان خواهیم داد.

   روی افزودن کلیک کنید ، سیستم از شما می خواهد که Contributor Covenant یا Citizen Code of Conduct را انتخاب کنید :

   اولی را انتخاب می کنم و روی بررسی و ارسال کلیک می کنم .

   در مرحله بعد، می توانید این فایل را ویرایش کرده و آن را commit کنید.

   در پایین، گزینه Commit direct to the master branch را انتخاب کنید و روی Commit new file کلیک کنید :

   در نتیجه، اگر به نمایه انجمن برگردیم ، متوجه می‌شویم که کد رفتار به‌عنوان اضافه شده علامت‌گذاری شده است:

   الگوی مشارکت و مسئله به روشی مشابه اضافه شده‌اند، بنابراین من این را نشان نمی‌دهم. خودتان آن را انجام دهید ؛)

5. الگوی درخواست کشش را اضافه کنید .

   اما در این مورد جداگانه صحبت خواهیم کرد.

   نمی‌دانم چرا GitHub همان گزینه مناسب را برای تنظیم قالب Pull-Request اضافه نکرده است، بنابراین باید مستندات را مطالعه کرده و به صورت دستی اضافه کنید.

   برای انجام این کار، روی ایجاد فایل جدید در ریشه مخزن کلیک کنید :

   نام فایل باید این باشد: github/pull_request_template.md .

   آنچه را که نیاز داریم به قالب اضافه می کنیم و روی Commit new file کلیک می کنیم ، همانطور که در بالا انجام دادیم. من قرار نبود چرخ را دوباره اختراع کنم و نمونه ای پیدا کردم که به نظرم کاملاً قابل استفاده بود.

   به این ترتیب کل نمایه انجمن پر می شود:

6. یک نشانگر مخزن الگو اضافه کنید .

   برای انجام این کار، به گزینه Settings در مخزن بروید و کادری که در آن نوشته شده است Template Repository را علامت بزنید:

   و تمام، قالب برای ایجاد پروژه های جدید آماده است. بنابراین، زمانی که نیاز به ایجاد پروژه های جدید داشته باشیم، در زمان زیادی در آینده صرفه جویی خواهیم کرد. این همچنین به شما کمک می کند تا جزئیات مهم را از دست ندهید، زیرا اغلب اتفاق می افتد که فراموش می کنید چیزی را اضافه کنید، به عنوان مثال، یک مجوز یا یک الگوی واضح برای یک موضوع.

نحوه استفاده از مخزن قالب

دو گزینه برای استفاده وجود دارد:

1. هنگامی که یک قالب مستقیماً متعلق به شما است: هنگام ایجاد یک مخزن جدید، به شما این امکان داده می شود که از یک الگو از لیست قالب هایی که مالک آن هستید ایجاد کنید:

2. وقتی قالب خارجی است: اینجا هم مشکل خاصی وجود ندارد. به آن الگو بروید و روی دکمه Use this template کلیک کنید . در اینجا من از انیمیشن سند رسمی استفاده خواهم کرد:

بیایید آن را جمع بندی کنیم

در این مقاله به موارد زیر توجه کردیم:

• مخزن GitHub چیست.
• مخزن قالب چیست.
• آنچه باید در مخزن الگو باشد.
• نحوه ایجاد یک مخزن قالب؛
• نحوه استفاده از مخزن قالب

البته، بر اساس این الگو، می توانید از قبل موارد خاص تری ایجاد کنید. برای مثال، من الگوهای بیشتری را با سیستم‌های ساخت maven یا gradle که قبلاً پیکربندی شده‌اند ایجاد کردم. علاوه بر این: می توانید یک الگوی مخزن بوت Spring بر اساس دو مورد آخر ایجاد کنید. برای گروه بندی همه قالب ها، یک سازمان مخزن قالب در GitHub با تمام قالب ها ایجاد کردم. در حساب GitHub من مشترک شوید

لینک های مفید

• سازمان با تمام قالب هایی که ایجاد کردم
• وبلاگ GitHub: ایجاد مخزن جدید با الگوهای مخزن نحوه ایجاد یک الگو برای مخازن
• راهنمای GitHub: درباره مخازن در مورد اینکه مخازن چیست.
• راهنمای GitHub: ایجاد یک مخزن از یک الگو نحوه ایجاد یک پروژه جدید بر اساس یک الگو
• راهنمای GitHub: صدور مجوز شرح مخزن مجوز برای پروژه ها
• راهنمای GitHub: یک توضیح مخزن برای ایجاد یک مخزن ایجاد کنید
• راهنمایی های راهنمای منبع باز برای ایجاد/توصیف پروژه های منبع باز.
• راهنمای GitHub: اضافه کردن یک الگوی درخواست کشش - ایجاد یک الگو برای درخواست‌های کشش.

بیشتر از مقالات من

• اشکال زدایی در Intellij IDEA: راهنمای مبتدیان
• راهنمای ایجاد کلاینت برای Skyscanner API و انتشار آن در jCenter و Maven Central [بخش 1]
• راهنمای ایجاد یک کلاینت برای Skyscanner API و انتشار آن در jCenter و Maven Central [بخش 2]
• ایجاد یک سیستم نظارت بر قیمت بلیط هواپیما: راهنمای گام به گام [بخش اول]
• ایجاد یک سیستم نظارت بر قیمت بلیط هواپیما: راهنمای گام به گام [قسمت 2]
• ایجاد یک سیستم نظارت بر قیمت بلیط هواپیما: راهنمای گام به گام [بخش 3]
• ورود به سیستم: چه، چگونه، کجا و با چه چیزی؟
• چگونه یک آزمون مصاحبه به یک کتابخانه منبع باز تبدیل شد
• تاریخچه موفقیت. 20 ساعت برنامه نویسی در هفته، فوق لیسانس و زندگی شخصی
• چگونه کار پیدا کنیم؟ نکاتی برای ارسال رزومه