10. راهنمای مشارکت در توسعه

به بخش مشارکت دیتائیست خوش آمدید! دیتائیست یک پروژه متن‌باز (Open-Source) است و توسعه آن بدون حمایت و مشارکت شما توسعه‌دهندگان عزیز امکان‌پذیر نیست. شما می‌توانید با گزارش باگ‌ها، پیشنهاد ویژگی‌های جدید، یا ارسال کد (Pull Request) به رشد این اکوسیستم کمک کنید.

10.1. مراحل گام‌به‌گام مشارکت در کد (Git Workflow)

برای ارسال کدهای خود به مخازن دیتائیست، لطفاً فرآیند استاندارد زیر را دنبال کنید:

  1. فورک کردن مخزن (Fork): ابتدا مخزن پروژه مورد نظر خود را در گیت‌هاب به حساب کاربری خود فورک کنید.

  2. کلون کردن و ساخت شاخه جدید (Clone & Branch): پروژه را روی سیستم خود کلون کرده و یک شاخه (Branch) جدید و معنادار بسازید:

    git clone https://github.com/your-username/repository-name.git
cd repository-name
git checkout -b feature/my-new-feature

  3. اعمال تغییرات و کامیت کردن (Commit): تغییرات خود را طبق اصول کدنویسی پروژه اعمال کنید. پیام‌های کامیت شما باید خلاصه، واضح و به زبان انگلیسی (یا طبق الگوی پروژه) باشند:

    git commit -m "feat: add new feature for data processing"

  4. ارسال و ایجاد درخواست ادغام (Pull Request): تغییرات را به فورک خود Push کرده و از طریق گیت‌هاب یک Pull Request (PR) به شاخه اصلی (main یا develop) پروژه دیتائیست ثبت کنید:

    git push origin feature/my-new-feature

10.2. قوانین و استانداردهای کدنویسی

برای حفظ کیفیت و یکدستی کدهای پروژه، لطفاً به نکات زیر توجه داشته باشید:

  • کد تمیز (Clean Code): کدهای خود را خوانا، بهینه و همراه با کامنت‌های ضروری بنویسید.

  • تست‌ها (Testing): در صورت امکان، برای قابلیت‌های جدیدی که اضافه می‌کنید، تست‌های مربوطه را بنویسید تا مطمئن شویم عملکرد قبلی سیستم مختل نمی‌شود.

  • پایداری سیستم: مطمئن شوید که کد شما قبل از ارسال، بدون خطا کامپایل و اجرا می‌شود.

10.3. گزارش خطاها (Bug Reports) و پیشنهادها

اگر در هنگام کار با نرم‌افزارها به باگ برخورد کردید یا ایده‌ای برای بهبود سیستم دارید، می‌توانید آن را در بخش Issues مخزن مربوطه ثبت کنید. در هنگام گزارش باگ لطفا موارد زیر را مشخص کنید:

  • نسخه سیستم‌عامل و نرم‌افزار مورد استفاده

  • مراحل دقیق برای بازتولید (Reproduce) خطا

  • رفتار مورد انتظار در برابر رفتار فعلی سیستم همراه با لاگ یا اسکرین‌شات

10.4. کانال‌های ارتباطی و پشتیبانی

اگر در هر یک از مراحل مشارکت یا راه‌اندازی محیط توسعه به مشکل خوردید، می‌توانید از راه‌های زیر با تیم هسته دیتائیست و سایر توسعه‌دهندگان در ارتباط باشید:

از اینکه وقت و تخصص خود را برای ارتقای دیتائیست می‌گذارید، صمیمانه سپاسگزاریم! 💙