برنامه‌نویسی

نکته‌هایی که باید در پروفایل GitHub خود رعایت کنید

نکته‌هایی که باید در پروفایل github خود رعایت کنید

شاید شما هم از آن افرادی باشید که پروژه‌های زیادی را در زمان کارآموزی خود انجام داده‌اید و حتی مستندات کاملی برای آن‌ها در نظر گرفته‌اید اما زحمت بارگذاری و نگهداری این پروژه‌ها را در GitHub به خود نداده باشید و حال متوجه شده‌اید که یک فرصت را از دست داده‌اید.

حقیقت این است که نگهداری از پروفایل GitHub به زمان و تلاش زیادی نیاز دارد، نوشتن مستندات و به‌روز نگه داشتن کدها در زمانی که پروژه دیگری داشته باشید، سخت است. بااین‌حال فقط با کمی تلاش بیشتر می‌توانید پروژه‌های کارآموزی یا جانبی خود را به یک نمونه کار معنادار تبدیل کنید و همان‌طور که می‌دانید داشتن نمونه کار در حوزه‌‌ی IT بسیار مهم است.

کدام‌یک از افراد جویای کار سود بیشتری از پروژه‌های GitHub می‌برند؟

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

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

ما در این مقاله قصد داریم تا تمام نکاتی را که در تسریع کسب شغل مورد نظرتان می‌بایست در پروفایل GitHub خود رعایت کنید، بررسی خواهیم کرد.

۱) استفاده از README را در ریپازیتوری‌های خود فراموش نکنید

مستندات برای کدهای شما نه فقط برای کاربرانی که سعی در استفاده از ابزار شما دارند بلکه برای مدیران و افرادی که می‌خواهند شما را استخدام کنند، بسیار مفید است. مستندات خوب نشان‌دهنده‌ی این است که:

  1. مهارت‌های ارتباطی بسیار خوبی دارید.
  2. می‌دانید که چگونه بر روی یک پروژه بلند مدت سرمایه‌گذاری کنید.

فراموش نکنید که در مستندات خود، هدف و دلیل استفاده از پروژه‌تان را ذکر کنید و یک دستورالعمل نصب قرار دهید تا کاربران بتوانند ابزار یا محصول شما را به راحتی نصب و استفاده کنند. همچنین یک دِمو به صورت screenshot، gif یا حتی یک لینک از نسخه‌ی اجرا شده‌ی برنامه را در README قرار دهید تا کاربران محصول یا ابزار شما را به آسانی مشاهده کنند.

۲) کدهای تمیز و سازمان‌یافته بنویسید

کدهای تمیز و سازمان‌یافته بنویسید

زمانیکه با یک تیم همکاری می‌کنید، نوشتن کدهای تمیز امری بسیار ضروری است. یکی از مشکل‌هایی که ممکن است در استخدام شما به‌وجود بیاید به دلیل مشاهده‌ی کاکرد ضعیف کدهای شما است.

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

کدهای خود را کامنت گذاری کنید، به عنوان مثال در پایتون می‌توانید از Docstrings استفاده کنید. همچنین در نظر داشته باشید که کامنت‌های خود را تا حد امکان کوتاه و مختصر بنویسید. برای کاهش توضیح‌های اضافی، نام‌های معنی‌دار برای متغیرها در نظر بگیرید و کدها را ساده نگه‌دارید. کامنت‌های شما باید هدف آن قطعه کد را توضیح دهند.

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

۳) فعال بمانید

حساب github خود را فعال نگه‌ دارید

هدف: رنگ‌های سبز نشان می‌دهد که شما در پلتفرم GitHub فعال هستید و دائما در پروژه‌ها مشارکت داشته‌اید که این‌ها برای مدیران بسیار جالب است.

قانون کلی: کدهای خود را به‌روز نگهدارید و کدهای جدید یا تغییرات را مرتبا commit کنید. آیا روی پروژه‌‌ی دانشجویی خود کار می‌کنید؟ با پیشرفت در پروژه، کدهای موجود در GitHub را به‌روز کنید. داشتن پروژه‌های کوچک خوب است اما سعی کنید به پروژه‌های خود تنوع دهید تا مجوعه مهارت‌های مختلف خود را به نمایش بگذارید.

پروژه‌های خود را به‌روز نگه دارید. همان‌طور که چیزهای بیشتری یاد می‌گیرید، احتمالا تغییرها و به‌روزرسانی‌های جدیدی وجود خواهند داشت که باید در پروژه‌های قدیمی خود ایجاد کنید.

به‌غیر از تغییرهای مورد نیاز در کدهای ریپازیتوری خود نیز می‌توانید برای نشان دادن فعالیت‌های بیشتر به دیگران کمک کنید، برای مثال:

  • یک issue ایجاد کنید.
  • یک pull request برای مشارکت در کدهای دیگر بفرستید.
  • برای pull requestهای موجود، review ارسال کنید.

آیا در محل کار خود از GitHub استفاده می‌کنید؟ می‌توانید Private Contributionها را در پروفایل خود فعال کنید تا نشان داده شوند.

private contributionها را در contribution settings فعال کنید

۴) از GitHub Pages استفاده کنید

GitHub Pages ابزاری بسیارعالی و قدرتمند است که می‌توانید به کمک آن در ریپازیتوی‌های خود یک صفحه‌ی وب را میزبانی کنید و بلافاصله کاربران می‌توانند پروژه‌ی شما را در آن صفحه‌ی وب مشاهده کنند.

اگر پروژه‌ی شما یک وبسایت باشد، به کمک GitHub Pages تنها با چند کلید ساده می‌توانید صفحه‌ی index.html را در GitHub میزبانی کنید. همچنین هر تغییری ایجاد کنید بدون نیاز به استقرار مجدد در صفحه‌ی میزبانی شده نمایش داده می‌شود. داشتن یک صفحه‌ی دمو از پروژه‌ی شما می‌تواند در نشان دادن مهارت‌هایتان بسیار کلیدی باشد. اگر نمی‌دانید چگونه دموی پروژه‌های خود را میزبانی کنید، استفاده از GitHub Pages گزینه‌ی بسیار خوبی است.

۵) اطلاعات شخصی پروفایل خود را به‌روز نگه‌ دارید

اطلاعات شخصی پروفایل خود را به‌روز نگه‌ دارید

اطلاعات تماس و حرفه‌‌ای خود را در پروفایل‌تان قرار دهید. افرادی که می‌خواهند شما را استخدام کنند از ابزارهای جستجو برای پیدا کردن پروفایل شما بر اساس موقعیت مکانی استفاده می‌کنند، بنابراین به راحتی با استفاده از موقعیت مکانی در پروفایل خود، در جستجوی آن‌ها نشان داده می‌شوید.

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

به یاد داشته باشید که حساب کاربری GitHub، رزومه شما نیست. پروفایل GitHub شما برای مدیران مانند مکملی در مصاحبه‌ی کاری شما است. پس بدین صورت از GitHub خود به عنوان یک مرکزیت برای همه‌ی موارد استفاده نکنید، توضیح‌های خود را مختصر نگه‌ دارید و کمی از شخصیت خود را در آن نشان دهید.

نکته‌های دیگر

  1. توضیح‌ها (description) و برچسب‌ها (tags) را به ریپازیتوری‌های خود اضافه کنید. همچنین این موارد را مختصر و آزمونده نگه دارید.
  2. در commit messageهای خود حرفه‌ای و آموزنده باشید. موارد معنی‌دارتری بنویسید، مثلا مختصر توضیح دهید که چرا بخشی از کدها کار نمی‌کند.
  3. اگر به‌دنبال مشارکت دیگران در پروژه خود هستید پس راهنماهای مورد نیاز برای مشارکت دیگران در پروژه‌تان را به صورت شفاف قرار دهید.
  4. چیزهای درهم و برهمی مانند ریپازیتوری‌های فورک شده‌ای که روی آن‌ها کار نکرده‌اید را حذف کنید.
  5. در جامعه‌ی کاربری توسعه‌دهندگان حضور داشته باشید و در پروژه‌های متن‌باز مشارکت کنید.

جمع‌بندی

اگر به‌دنبال پیدا کردن شغل مورد نظر خود هستید پس توصیه می‌شود از GitHub به چشم یک ابزار مفید استفاده کنید و حضوری مفید در آن به عمل بیاورید .

منبع: https://codeburst.io/what-makes-a-good-github-profile-ced754284e3d