9 قاعدة
التوثيق
وجود README بطول 500 حرف على الأقل، وLICENSE معروف (للمستودعات العامة)، وCHANGELOG وCONTRIBUTING، وقسم تصميم في architecture.md.
كن جاهزًا للتدقيق بتقرير واحد.
تفحص وحدة الامتثال كل مستودع وفق قائمة من 36 قاعدة: التوثيق ونظافة المستودع والأمان وCI والتكامل. ويُنتج كل فحص درجة مرجّحة وقائمة نتائج يمكن تسليمها للمدقق.
شاشات من تثبيت قيد التشغيل
36 قاعدة في خمس فئات
تنظر وحدة الامتثال إلى ما يحمله المستودع وكيف أُعدّ، لا إلى منطق الكود. وكل قاعدة سؤال بنعم أو لا له درجة خطورة.
12 قاعدة
نظافة المستودع
.gitignore و.editorconfig، ووصف ووسوم، وفرع افتراضي باسم main أو master، ومستودع غير مؤرشف؛ وللخلفيات Dockerfile متعدد المراحل وdocker-compose محلي.
7 قاعدة
الأمان
سياسة أمان، وتحديثات تلقائية للتبعيات، و.env.example، وحاويات تعمل بمستخدم غير جذري، وصور أساس من سجلات مسموح بها، وNuGet من مصادر مسموح بها فقط.
5 قاعدة
التكامل المستمر
وجود مسار CI يشغّل الاختبارات، وشارة بناء في README، وسكربت lint للواجهات، وFastlane لتطبيقات الجوال.
3 قاعدة
التكامل
بيانات اعتماد Git للمشروع سليمة، وراجع ArchPilot طلب دمج مؤخراً، ولمساحة العمل قناة إشعارات.
أي القواعد تنطبق على أي مشروع
لا تملك الواجهة Dockerfile ليُفحص، ولا يملك تطبيق الجوال robots.txt. أنت تختار حزم كل مشروع، وتنطبق القواعد العامة وقواعد التكامل دائماً.
الإجابة الغائبة ليست إخفاقاً
نتيجة كل قاعدة إما ناجحة أو فاشلة أو متخطاة أو خطأ. ولا يُحتسب إلا الناجح والفاشل مرجّحين بالخطورة؛ والقاعدة التي تعذّرت الإجابة عنها تخرج من المقام بدل أن تخفض الدرجة.
- إلزامية×2
- موصى بها×1
- اختيارية×0.5
- ناجحة · تُحتسب
- فاشلة · تُحتسب
- متخطاة · مستبعدة
- خطأ · مستبعدة
لماذا هكذا: انقطاع VPN جعل كل المشاريع تُظهر 6/100 ذات مرة. خادم Git غير المتاح لا يقول شيئاً عن المستودع، لذا لم يعد يُحتسب.
كيف يجري الفحص
-
يُطلق
يدوياً، أو بجدولة يومية أو أسبوعية لمجموعة مشاريع أو قائمة مشاريع.
-
في الطابور
يلتقطه عامل خلال ثوانٍ، ويسجّل الفحص من أو ما الذي أطلقه.
-
تُجاب القواعد
تُقرأ الملفات وإعدادات المستودع وحماية الفروع من مزوّد Git، ولا يُستنسخ شيء.
-
تُقيَّم وتُحفظ
تنضم الدرجة إلى سجل المشروع وبطاقة صحته، وإلى بريد الملخص إن كنت مشتركاً.
تُفعَّل القواعد أو تُعطَّل على ثلاثة مستويات: افتراضي التثبيت ومساحة العمل والمشروع. ويغلب الإعداد الأضيق نطاقاً.
شاهده داخل المنتج
كل لقطات الشاشة
ادخل تدقيقك القادم وأنت مستعد
اختر حزمة كل مشروع وفعّل القواعد التي تريدها وجدول الفحوص؛ وتبقى الدرجة محدّثة دون أن يتذكر أحد تشغيلها.