در این پست وبلاگ، برخی از بهترین روش ها برای استفاده از GitHub در هکاتون ها را مرور خواهیم کرد. هر بار که در یک هکاتون شرکت می کنیم، پروژه خود را در Github آپلود می کنیم و URL GitHub را در ارسال پروژه خود قرار می دهیم. GitHub نقش مهمی در نحوه ارزیابی پروژه شما توسط داوران ایفا می کند!
در پایان این وبلاگ، خواهید فهمید که چگونه از GitHub به نفع خود در هکاتون ها استفاده کنید و در راه ایجاد یک پروژه موفق باشید. پس بیایید شروع کنیم!
ویژگی های معمولا فراموش شده:
1. تاریخچه تعهد GitHub:
این معمولاً در قوانین هکاتون ذکر شده است. می توان اشاره کرد که آنها تاریخچه تعهد پروژه را بررسی می کنند تا مطمئن شوند که شما آن پروژه را در طول دوره هکاتون انجام داده اید و نه قبل از آن.
نکته: کد کامل خود را در یک commit فشار ندهید! در عوض، سعی کنید پروژه خود را از ابتدا در Github بسازید.
همچنین توصیه می شود به محض شروع دوره هک، یک مخزن ایجاد کنید و در آنجا شروع به ساخت کنید! سپس تغییرات کوچک و ویژگی هایی را که به Repo اضافه کرده اید فشار دهید.
می توانید متوجه شوید که برخی از معیارهای حداقل تعهد وجود دارد. در این صورت شما یک مزیت خواهید داشت!
سعی کنید در زمانی که می خواهید روی یک پروژه کار کنید، تاریخچه تعهدات خوبی را حفظ کنید!
2. مشکلات GitHub
وقتی سعی می کنیم روی پروژه های کوتاه مدت مانند پروژه های هکاتون کار کنیم، اغلب احساس می کنیم که ویژگی Github Issues مهم نیست. اما اضافه کردن مسائل در حین کار بر روی یک پروژه یک تمرین خوب است. بسیاری از داوران دوست دارند آن را در پروژه شما ببینند. می توانید از آن به عنوان لیست کارهای خود یا بحث گروهی در مورد یک ویژگی جدید استفاده کنید.
📌نکته: لازم نیست برای یک موضوع تعاریف فنی یا سخت ارائه دهید، می تواند بسیار ساده باشد.
ایجاد این نوع موضوع، روند تفکر و فرآیند طوفان فکری شما را در کل به داوران نشان می دهد که در نهایت می تواند به شما در هکاتون برتری دهد.
3. تابلوهای پروژه
مانند مسائل GitHub، اکثر مردم فکر می کنند که بردهای پروژه Github مفید نیستند. اما در واقعیت، کمی از مهارت های مدیریت پروژه شما را نشان می دهد.
فرض کنید، پروژه شما بسیار خوب است، اما می توانید به داوران نشان دهید که چگونه پروژه را مدیریت کرده اید و مسائل را اولویت بندی کنید. این احساس خوبی ایجاد می کند که شما پروژه را جدی می گیرید و می خواهید آن را به طور سیستماتیک انجام دهید.
4. استانداردهای انجمن GitHub
اگر در تلاش برای ساختن یک پروژه هستید، بسیار ضروری است. داشتن استانداردهای جامعه نه تنها برای پروژه های هکاتون بلکه برای پروژه های دیگر بسیار خوب است.
اگر به Insights بروید، می توانید استانداردهای جامعه را در آنجا ببینید
در Insights اگر به استانداردهای انجمن بروید، می توانید یک چک لیست را ببینید. حتی اگر چیزی را برای اضافه کردن به مخزن خود فراموش کنید! می توانید آن را در اینجا بررسی کنید. فقط سعی کنید این چک لیست را کامل کنید.
مثال: در اینجا سیاست امنیتی هنوز اضافه نشده است!
- 🎯 چرا استانداردهای جامعه مهم هستند؟
فقط قرار دادن کد خود در GitHub پروژه شما را منبع باز نمی کند، افزودن مجوز، Readme، کد رفتار و مستندات به آن، آن را به طور کلی یک پروژه متن باز می کند..
🔮نکته:
برای پروژه Hackathon، لازم نیست Github Discussion را فعال کنید.
5. تگ پروژه GitHub
ممکن است فکر کنید که چرا مهم است؟
ساده ترین پاسخ بله است! مهم است! این باعث می شود پروژه شما قابل کشف تر و قابل ارائه تر باشد!
6. GitHub ReadMe
یک فایل README خوب بخش مهمی از هر پروژه GitHub است. اطلاعاتی در مورد پروژه از جمله هدف آن، نحوه راه اندازی و نحوه استفاده از آن ارائه می دهد.
داشتن یک README به خوبی نوشته شده می تواند به کاربران کمک کند تا پروژه شما را درک کنند و تصمیم بگیرند که آیا می خواهند از آن استفاده کنند یا خیر. همچنین می‌تواند به مشارکت‌کنندگان در درک نحوه مشارکت در پروژه و نوع کمک مورد نیاز کمک کند.
💎 در اینجا برخی از مزایای داشتن یک README خوب برای پروژه GitHub شما آورده شده است:
-
این به کاربران کمک می کند تا بفهمند پروژه چه کاری انجام می دهد و چگونه می تواند برای آنها مفید باشد.
-
دستورالعمل های واضحی در مورد نحوه نصب و راه اندازی پروژه ارائه می دهد.
-
نحوه استفاده از پروژه و ویژگی های موجود را توضیح می دهد.
-
هر وابستگی لازم برای اجرای پروژه را فهرست می کند.
-
به مشارکت کنندگان و نگهبانان اعتبار می دهد.
-
مکانی برای گزارش مشکلات و درخواست ویژگی‌ها برای کاربران فراهم می‌کند.
به طور خلاصه، یک README خوب می تواند پروژه شما را کاربرپسندتر کند و به آن کمک کند تا کاربران و مشارکت کنندگان بیشتری را جذب کند.
مثال:
🔮 نکته پاداش:
برخی از ویژگی ها نیز وجود دارد که می توانید آنها را غیرفعال کنید! اگر پروژه شما هیچ نسخه و بسته ای ندارد، می توانید آنها را غیرفعال کنید در غیر این صورت ظاهر خوبی ندارد.
شما باید سعی کنید چیزهایی را که استفاده می کنید و مرتبط با پروژه خود هستند نشان دهید. در غیر این صورت، با خیال راحت آنها را پنهان کنید! تمرین خوبی است!
✅موارد مهم:
-
Readmes خوب قطعاً نظر را جلب می کند.
-
حفظ تاریخچه تعهد بسیار مهم است.
-
تلاش های اضافی برجسته است.
-
آسان کردن قاضی مستقیماً به نفع شماست.
-
هکاتون ها برای سرگرمی هستند و یادگیری و کاوش ابزار با پتانسیل کامل آن همیشه یک تجربه عالی است.
نتیجه
بابت خواندن این وبلاگ از شما ممنونم. امیدوارم امروز چیز جدیدی یاد گرفته باشید! اگر این وبلاگ را مفید یافتید، لطفاً برای پست های بیشتر وبلاگ مانند این در آینده، لایک کنید، به اشتراک بگذارید و من را دنبال کنید.
