Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

قائمة مراجعة التوثيق

استخدم هذه القائمة عند مراجعة طلبات الدمج المعتمدة على التوثيق.

  • اكتمل ./scripts/check_quality.sh قبل الدمج
  • اكتمل ./scripts/check_representative_examples.sh قبل الدمج
  • اكتمل mdbook build docs عندما يتغير التوثيق أو الأمثلة أو نصوص الجذر
  • تم تحديث الصفحتين العربية والإنجليزية معًا عندما يكون التغيير موجّهًا للمستخدم
  • أضيفت الصفحة إلى docs/src/SUMMARY.md
  • وُضع المثال داخل الـ crate المالكة
  • تم تحديث فهرس الأمثلة عند إضافة مثال جديد
  • أضيفت روابط عكسية من الأمثلة المرجعية إلى صفحات الشرح عند الحاجة
  • أضيف rustdoc للسطح العام الجديد عند موضع تعريفه
  • لم تُرفع المساعدات الداخلية إلى واجهة الوثائق المولدة دون قصد
  • تستخدم الأوامر في التوثيق استدعاءات الأمثلة المرتبطة بالـ package عند الحاجة
  • تم تحديث ملاحظات التحقق البصري عندما يتغير سلوك الأمثلة المرجعية أو سلوك الرندر
  • تم تحديث README وREADME_AR إذا تغيّرت قصة الدخول
  • تم تحديث changelog.md إذا كان التغيير ملحوظًا

جودة هندسية

  • اكتمل ./scripts/check_public_api_surface.sh عندما يتغير سطح الاستيراد أو تركيب الإضافات أو تعريض المسارات المهجورة
  • اكتمل ./scripts/check_engine_boundary_guardrails.sh عند نقل المنطق بين engine وinteraction وwidgets
  • لم يضف التغيير hotspot كبيرة في ملفات المصدر دون سبب واضح
  • لم يوسّع التغيير السطح العام أو الاقتران بلا حاجة موجّهة للمستخدم
  • لم يضف التغيير اعتمادًا جديدًا على univis_ui_engine::internal أو وحدات المحرك المخفية خارج crate المحرك
  • بقيت التسمية منسجمة مع صفحات التسمية والمعمارية الخاصة بالمحافظين