Skip to content
The Chat Archive
o1-preview-2024-09-12· OpenAI WildChat-4.8M (AI2)

https://doc.flectrahq.com/3.0/contributing/development/coding_guidelines.html اینو برام…

  1. User

    https://doc.flectrahq.com/3.0/contributing/development/coding_guidelines.html

    اینو برام به فارسی خلاصه با جزئیات کن

  2. Assistant

    راهنمای کدنویسی در Flectra نسخه ۳.۰ به توسعه‌دهندگان کمک می‌کند تا کدی تمیز، قابل نگهداری و هماهنگ با استانداردهای پروژه بنویسند. این راهنما شامل نکات و دستورالعمل‌های زیر است:

    1. استانداردهای کدنویسی عمومی:

      • پیروی از استانداردهای PEP 8 برای کدنویسی پایتون.
      • استفاده از فاصله‌گذاری ۴ فاصله (spaces) برای تورفتگی کد.
      • حداکثر طول خطوط کد باید ۷۹ کاراکتر باشد.
    2. نام‌گذاری:

      • استفاده از نام‌های معنادار و توصیفی برای متغیرها، توابع و کلاس‌ها.
      • نام کلاس‌ها باید به صورت CamelCase باشد (مثلاً MyClass).
      • نام توابع و متغیرها باید با حروف کوچک و زیرخط (_) نوشته شوند (مثلاً my_function).
    3. مستندسازی:

      • استفاده از رشته‌های مستندات (Docstrings) برای توابع، کلاس‌ها و ماژول‌ها.
      • توضیح ورودی‌ها، خروجی‌ها و رفتار تابع در مستندات.
      • پیروی از سبک مستندسازی reStructuredText یا Sphinx.
    4. نظرات (Comments):

      • نوشتن نظرات مفید و ضروری که به فهم کد کمک کند.
      • اجتناب از نظرات غیرضروری که واضح هستند.
      • نظرات باید به زبان انگلیسی باشند.
    5. ساختار کد:

      • تقسیم کد به ماژول‌ها و بسته‌ها برای سازماندهی بهتر.
      • هر فایل باید حاوی یک کلاس اصلی یا مجموعه‌ای از توابع مرتبط باشد.
      • ترتیب وارد کردن (import) ماژول‌ها باید از استانداردهای پایتون پیروی کند (ابتدا ماژول‌های استاندارد، سپس خارجی، سپس داخلی).
    6. استثناءها و مدیریت خطا:

      • استفاده صحیح از بلوک‌های try-except برای مدیریت استثناءها.
      • ایجاد استثناءهای سفارشی در صورت نیاز.
      • ارائه پیام‌های خطای مفید برای کاربران و توسعه‌دهندگان.
    7. تست‌ها:

      • نوشتن تست‌های واحد (Unit Tests) برای کد جدید یا تغییر یافته.
      • استفاده از چارچوب تست Flectra یا ابزارهای استاندارد پایتون مانند unittest.
      • اطمینان از پوشش‌دهی مطلوب کد توسط تست‌ها.
    8. بهینه‌سازی و عملکرد:

      • نوشتن کد کارآمد و جلوگیری از به‌کارگیری الگوریتم‌های ناکارا.
      • اجتناب از بهینه‌سازی زودرس؛ ابتدا بر خوانایی و درستی کد تمرکز کنید.
      • استفاده از ابزارهای پروفایلینگ در صورت نیاز به بهبود عملکرد.
    9. امنیت:

      • رعایت بهترین روش‌های امنیتی در کدنویسی.
      • اجتناب از کدهای آسیب‌پذیر به حملات Injection، XSS و غیره.
      • اعتبارسنجی ورودی‌های کاربر و استفاده از مکانیزم‌های امنیتی Flectra.
    10. همکاری و کنترل نسخه:

      • استفاده از Git برای کنترل نسخه و پیگیری تغییرات کد.
      • پیروی از استانداردهای نام‌گذاری شاخه‌ها و پیام‌های تعهد (Commit Messages).
      • انجام بررسی کد (Code Review) و مشارکت در بررسی کد دیگران.
    11. سبک رابط کاربری:

      • پیروی از راهنماهای طراحی رابط کاربری Flectra.
      • استفاده از عناصر و ویجت‌های استاندارد برای هماهنگی در ظاهر برنامه.
      • اطمینان از سازگاری با مرورگرها و دستگاه‌های مختلف.
    12. ترجمه و محلی‌سازی:

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

    این راهنمای کدنویسی به منظور تسهیل همکاری بین توسعه‌دهندگان و حفظ کیفیت کد در طول زمان تدوین شده است. با پیروی از این دستورالعمل‌ها، می‌توان اطمینان حاصل کرد که پروژه Flectra قابل اعتماد، پایدار و قابل گسترش باقی می‌ماند.