من پروژه‌های منبع باز را جمع‌آوری می‌کنم، مانند برخی از افراد، سرورهای اختلاف را جمع‌آوری می‌کنند. برای دقیق بودن، من 525 مخزن دارم. اکنون، قبل از اینکه سر من فریاد بزنید، بسیاری از آنها مربوط به درس‌های بوت کمپ من هستند، زمانی که من در حال یادگیری کدنویسی بودم. اما من بیش از یک بار برای شروع و توقف پروژه ها شناخته شده ام. چیزی که من دارند آموخته شده از طریق آن تجربه اهمیت ثبات است. اگر در سازمانی هستید که چندین مخزن دارد، ممکن است متوجه شوید که همان فایل‌ها را بارها و بارها به فایل‌هایی اضافه می‌کنید، مانند الگوهای CODE_OF_CONDUCT.md، Pull Request (PR) و Issue، و CONTRIBUTING.md. به‌عنوان توسعه‌دهندگان، افزودن مکرر این فایل‌ها به نظر می‌رسد که در حال نقض اصول کد DRY هستیم. خوشبختانه مخزن .github می تواند به حل این مشکل کمک کند.
الف چیست .github مخزن؟
آ .github مخزن نوع خاصی از مخزن در GitHub است که به نگهبانان اجازه می دهد فایل ها و قالب های سلامت جامعه را برای پروژه های خود ذخیره کنند.
فایل های بهداشت جامعه رفاه جامعه را ارتقا می دهند و بر ارتباطات، مستندسازی، حمایت از اعضا از طریق کد رفتار و شناخت جامعه تمرکز دارند.
را .github مخزن – یافت شده در https://github.com/<username/organization>/.github– می تواند فایل های سلامت جامعه را برای سازمان شما به عنوان فایل های پیش فرض قرار دهد. طبق گفته GitHub، “در حالی که خود فایل در مرورگر فایل یا تاریخچه Git برای هر مخزن ظاهر نمی شود، در سراسر گردش کار توسعه دهندگان ظاهر می شود، مانند هنگام باز کردن یک شماره جدید یا هنگام مشاهده نمایه انجمن، درست مثل اینکه مستقیماً به مخزن متعهد شد.»
با استفاده از a .github مخزن، به نگهبانان اجازه می‌دهد تا فایل‌ها و قالب‌هایی را که برای گردش کار و جامعه پروژه‌شان مهم هستند را به‌طور مؤثر مدیریت کنند و از ثبات در سرتاسر مخازن سازمان اطمینان حاصل کنند. پس چه چیزی به آن اضافه می کنید .github مخزن؟ یک مثال یک الگوی درخواست کشش است زیرا آنها اغلب در مخازن استاندارد هستند.
نحوه اضافه کردن یک الگوی روابط عمومی
اضافه کردن یک قالب روابط عمومی به شما .githubمخزن ساده است. ابتدا به مخزن مورد نظر رفته و بر روی دکمه “ایجاد فایل جدید” کلیک کنید. سپس در قسمت نام فایل تایپ کنید .github/PULL_REQUEST_TEMPLATE.md.
در قسمت متن اصلی می توانید محتوای قالب روابط عمومی خود را اضافه کنید. این می‌تواند شامل درخواست‌هایی برای اطلاعاتی مانند هدف روابط عمومی، تغییرات ایجاد شده، هرگونه مشکل یا نگرانی بالقوه، و هر زمینه یا منابع اضافی باشد که ممکن است مفید باشد – ما را در اینجا بررسی کنید. همچنین می‌توانید از علامت‌گذاری برای قالب‌بندی قالب استفاده کنید، که خوانایی و درک آن را آسان‌تر می‌کند.
هنگامی که الگوی روابط عمومی خود را اضافه کردید، روی دکمه “Commit new file” کلیک کنید تا آن را در مخزن خود ذخیره کنید. اکنون، هر بار که مشارکت‌کننده یک PR جدید را باز می‌کند، از او خواسته می‌شود از الگوی ایجاد شده شما استفاده کند.
ملاحظاتی برای نگهبانان
هنگام ایجاد یک قالب روابط عمومی، به خاطر داشته باشید که الگو به راحتی قابل خواندن و درک است. به یاد داشته باشید، الگو قرار است کار را برای شما و مشارکت کنندگان آسان تر کند. به چه اطلاعاتی نیاز دارید تا بتوانید روابط عمومی را به طور موثرتر بررسی کنید؟ چه اطلاعاتی می تواند یک مشارکت کننده جدید را از طریق نوشتن یک PR برای اولین بار راهنمایی کند؟
در نهایت، زیبایی استفاده از یک الگو برای همه مخازن خود این است که اگر تصمیم به به روز رسانی آن دارید، فقط باید این کار را در یک مکان انجام دهید. همانطور که پروژه شما تکامل می یابد و الزامات جدید ظاهر می شود، ممکن است متوجه شوید که الگو نیاز به بازبینی دارد یا ممکن است بازخوردی از مشارکت کنندگان و سایر نگهبانان داشته باشید و در صورت نیاز تغییراتی ایجاد کنید تا مطمئن شوید که الگوی روابط عمومی موثر و مفید باقی می ماند. اگر به محتوای بیشتر در رابطه با روابط عمومی علاقه دارید، به نوشتن اولین درخواست کششی خود مراجعه کنید: نکات، بهترین روش ها، و ابزارهای مبتنی بر هوش مصنوعی برای موفقیت و نحوه ایجاد یک الگوی درخواست کشش خوب (و چرا باید گیف اضافه کنید).
