گیتهاب (GitHub) یک سرویس میزبانی کد و مدیریت نسخه کد است که برای توسعه نرم‌افزار و کارهای مرتبط با آن استفاده میشود. این سرویس به توسعه‌دهندگان امکان می‌دهد که کدهای خود را آپلود و به اشتراک بگذارند، با همکاران و جامعه توسعه‌دهندگان همکاری کنند، مشارکت کنند، مشکلات را گزارش دهند و پروژه‌های مختلف را مدیریت کنند. در این مقاله به نحوه جذاب کردن پروفایل گیت هاب و ساخت پروفایل حرفه ای خواهیم پرداخت.
پروفایل گیت هاب شما اولین چیزی است که افراد هنگام بازدید از صفحه شما می بینند. بنابراین، مهم است که آن را به گونه ای طراحی کنید که جذاب و حرفه ای باشد. یکی از راه های انجام این کار، افزودن یک فایل README.md است.
فایل README.md یک فایل متنی ساده است که می توانید از آن برای ارائه خلاصه ای از خود، مهارت ها و پروژه های خود استفاده کنید. این یک فرصت عالی برای برجسته کردن نقاط قوت خود و جلب توجه بازدیدکنندگان است.
نحوه جذاب کردن پروفایل گیت هاب
همانطور که گفتیم برای جذاب تر کردن پروفایل گیت هاب، نیاز به فایل README.md داریم که ابتدا باید آن را ایجاد کنیم.
گیتهاب شامل برخی قابلیت‌های مخفی است که با انجام یک کار خاص فعال می‌شوند. به عنوان مثال برای ساخت همین فایل README، اگر یک مخزن با نام کاربری خود ایجاد کنید، یک فایل README در صفحه پروفایل شما نمایش داده میشود. این فایل README یک فایل متنی است که میتوانید از آن برای معرفی خود، پروژه‌های خود یا هر چیز دیگری که می‌خواهید استفاده کنید.
برای ایجاد این فایل README، مراحل زیر را دنبال کنید:
- به وب سایت گیت هاب بروید و وارد حساب خود شوید.
- روی دکمه “+” در بالای صفحه کلیک کنید و “Create repository” را انتخاب کنید.
- نام مخزن را “نام کاربری خودتان” وارد کنید.
- روی دکمه “Create repository” کلیک کنید.
پس از ایجاد مخزن، یک فایل README در صفحه پروفایل شما نمایش داده میشود. میتوانید این فایل را باز کنید و محتوای آن را ویرایش کنید.
فایل README.md از زبان Markdown برای قالب‌بندی محتوا استفاده می‌کند. Markdown یک زبان نشانه‌گذاری ساده است که به شما امکان می‌دهد متن خود را به شکل‌های مختلف قالب‌بندی کنید. برای آشنایی با این زبان نشانه‌گذاری میتوانید مستندات آن را از سایت markdownguide مطالعه کنید.
حالا که فایل README.md را ساختید و با Markdown آشنا شدید، میتوانید محتوای مورد نظر خود را در این فایل بنویسید. محتوا می‌تواند شامل عنوان، زیرعنوان، لیست‌ها، کدها، تصاویر و لینک‌ها باشد.
پس از نوشتن محتوای موردنظر، فایل README.md را ذخیره کرده و تغییرات را در ریپوزیتوری خود push کنید تا در صفحه پروژه شما در گیتهاب نمایش داده شود.
git add README.md git commit -m "Add README.md" git push
با این روند، شما میتوانید یک فایل README.md جذاب و مفید برای پروژه‌های خود در گیتهاب ایجاد کنید و اطلاعات کافی را برای همکاران و بازدیدکنندگان ارائه دهید.
چند نکته برای نوشتن یک فایل README.md
- با یک معرفی قوی شروع کنید. در چند جمله اول، خود را معرفی کنید و به خوانندگان بگویید که به چه چیزی علاقه دارید.
- مهارت های خود را برجسته کنید. به طور خلاصه، مهارت های فنی و نرم افزاری خود را فهرست کنید.
- پروژه های خود را به نمایش بگذارید. پیوندهایی به پروژه های برجسته خود ارائه دهید.
- شخصیت خود را نشان دهید. از زبان و تصاویری استفاده کنید که منعکس کننده سبک شخصی شما باشد.
البته، شما باید فایل README.md خود را با اطلاعات و سبک شخصی خود سفارشی کنید. با کمی تلاش، می توانید یک پروفایل گیت هاب ایجاد کنید که توجه بازدیدکنندگان را جلب کند و شما را به عنوان یک توسعه دهنده نرم افزار با استعداد معرفی کند. برای این کار میتوانید پروفایل های افراد حرفه ای را هم بررسی کنید که میتوانید کمک زیادی به شما بکند.
با استفاده از این نکات، می توانید یک فایل README.md ایجاد کنید که پروفایل گیت هاب شما را به سطح بالاتری برساند.
استفاده از قالب های کارتی در نمایش اطلاعات پروفایل
حتما شما هم در برخی از پروفایل ها، نمایش اطلاعات را به صورت کارتی دیده اید و شاید کنجکاو شده باشید که این نوع پروفایل ها چگونه ساخته میشود؟
این نوع نمایش اطلاعات که شامل تعداد کامیت ها، ستاره ها و غیره میشود از طریق API های آماده ایجاد میشود که در ادامه صفحه github-readme-stats را برای شما معرفی میکنم.
به عنوان مثال کافی است از کد زیر داخل فایل README.md خود استفاده کنید. فقط حتما باید به جای username، نام کاربری خودتان را وارد کنید:
در قسمت آخر کد بالا، اسم تم وارد شده است که شما بر اساس سلیقه خود می توانید آن را تغییر داده و تم مورد نظر خود را جایگزین کنید: dark، adical، merko، gruvbox، tokyonight، onedark، cobalt، synthwave، highcontrast، dracula
بیشتر بخوانید:
