پرش به محتویات

مشارکت

بررسی‌ها

همه‌ی بررسی‌ها با nox اجرا می‌شوند؛ همان sessionها هم روی سیستم خودتان و هم در CI. اگر uv نصب باشد، هر نسخه‌ای از Python که نصب نیست خودکار دانلود می‌شود.

uv tool install nox
nox -s lint types tests
session
lint ruff، lint و قالب‌بندی
types mypy، strict
tests همه‌ی نسخه‌های پشتیبانی‌شده‌ی Python و Django، با پوشش کامل شاخه‌ها
oldest قدیمی‌ترین نسخه‌ی همه‌ی وابستگی‌ها
package wheel ساخته‌شده، جدا نصب می‌شود؛ تست‌های فروشگاه نمونه رویش اجرا می‌شوند
messages کاتالوگ فارسی کامپایل می‌شود
docs همین سایت، بدون هیچ لینک شکسته - حین نوشتن nox -s docs -- serve

تست‌ها به‌طور پیش‌فرض روی SQLite اجرا می‌شوند، و روی PostgreSQL با DRF_PARCEL_TEST_DATABASE=postgres و متغیرهای استاندارد PG*.

قانون‌ها

  • اول قرارداد. هر تغییری در آنچه از سرور بیرون می‌رود، پیش از اینکه کد باشد تغییری در قرارداد است.
  • اسم تست‌ها بر اساس رفتاری است که نگه می‌دارند - test_a_page_never_holds_more_than_the_ceiling.py - و اسم تست می‌گوید اگر شکست بخورد در دنیای واقعی چه چیزی خراب شده. هر خطی را یک تست اجرا می‌کند.
  • هر جمله‌ای که انسان می‌خواند علامت می‌خورد، با gettext_lazy، و در src/drf_parcel/locale/fa/LC_MESSAGES/django.po ترجمه می‌شود (nox -s messages آن را کامپایل می‌کند). تست‌ها روی جمله‌ای که کاتالوگ ندارد شکست می‌خورند.
  • انگلیسی و فارسی. هر صفحه‌ی این مستندات name.md است، و فارسی‌اش name.fa.md کنارش.