إرشادات الإبلاغ عن المشاكل
تقارير الأخطاء والميزات الجديدة الفعالة حاسمة لتطوير XOOPS. يساعدك هذا الدليل على إنشاء مشاكل عالية الجودة.
قبل الإبلاغ
Section titled “قبل الإبلاغ”تحقق من المشاكل الموجودة
Section titled “تحقق من المشاكل الموجودة”ابحث دائماً أولاً:
- انتقل إلى مشاكل GitHub
- ابحث عن كلمات مفتاحية متعلقة بمشكلتك
- فحص المشاكل المغلقة - قد تكون محلولة بالفعل
- انظر إلى طلبات السحب - قد تكون قيد التقدم
أنواع المشاكل
Section titled “أنواع المشاكل”تقرير خطأ
Section titled “تقرير خطأ”خطأ هو سلوك غير متوقع أو عيب.
أمثلة:
- تسجيل الدخول لا يعمل
- أخطاء قاعدة البيانات
- التحقق من النموذج المفقود
- ثغرة أمنية
طلب ميزة جديدة
Section titled “طلب ميزة جديدة”طلب ميزة جديدة هو اقتراح لوظيفة جديدة.
أمثلة:
- أضف دعم ميزة جديدة
- تحسين الوظيفة الموجودة
- إضافة التوثيق المفقود
- تحسينات الأداء
الإبلاغ عن خطأ
Section titled “الإبلاغ عن خطأ”قالب تقرير الخطأ
Section titled “قالب تقرير الخطأ”## الوصفوصف موجز وواضح للخطأ.
## خطوات إعادة الإنتاج1. الخطوة الأولى2. الخطوة الثانية3. الخطوة الثالثة
## السلوك المتوقعما الذي يجب أن يحدث.
## السلوك الفعليما الذي يحدث بالفعل.
## البيئة- إصدار XOOPS: X.Y.Z- إصدار PHP: 8.2/8.3/8.4- قاعدة البيانات: MySQL/MariaDB الإصدار- نظام التشغيل: Windows/macOS/Linux- المتصفح: Chrome/Firefox/Safari
## لقطات الشاشةإذا كان قابلاً للتطبيق، أضف لقطات تظهر المشكلة.
## السياق الإضافيأي معلومات أخرى ذات صلة.
## الإصلاح المحتملإذا كان لديك اقتراحات لإصلاح المشكلة (اختياري).الإبلاغ عن طلب ميزة
Section titled “الإبلاغ عن طلب ميزة”قالب طلب الميزة الجديدة
Section titled “قالب طلب الميزة الجديدة”## الوصفوصف واضح وموجز للميزة.
## بيان المشكلةلماذا هذه الميزة مطلوبة؟ ما المشكلة التي تحلها؟
## الحل المقترحوصف التطبيق المثالي أو واجهة المستخدم.
## البدائل المدروسةهل هناك طرق أخرى لتحقيق هذا الهدف؟
## السياق الإضافيأي نماذج أولية أو أمثلة أو مراجع.
## التأثير المتوقعكيف ستستفيد المستخدمون؟ هل ستكون تغييراً فاصلاً؟مشاكل الأمان
Section titled “مشاكل الأمان”لا تبلغ علناً
Section titled “لا تبلغ علناً”لا تنشر أبداً مشكلة تقرير أمني علناً.
أبلغ بشكل خاص
Section titled “أبلغ بشكل خاص”- أرسل بريداً إلى فريق الأمان: security@xoops.org
- أدرج:
- وصف الثغرة
- خطوات إعادة الإنتاج
- التأثير المحتمل
- معلومات الاتصال بك
الإفصاح المسؤول
Section titled “الإفصاح المسؤول”- سنقر بالاستقبال في غضون 48 ساعة
- سنقدم تحديثات كل 7 أيام
- سننسق توقيت الإفصاح العام
أسماء المشاكل الجيدة
Section titled “أسماء المشاكل الجيدة”أمثلة جيدة
Section titled “أمثلة جيدة”✅ صفحة تسجيل الدخول تظهر صفحة فارغة عند فشل اتصال قاعدة البيانات✅ إضافة دعم المصادقة متعددة العوامل✅ منع حقن SQL في حقل الاسم✅ تحسين أداء استعلام قائمة المستخدمين✅ تحديث التوثيق الخاص بالتثبيت لـ PHP 8.2أمثلة سيئة
Section titled “أمثلة سيئة”❌ خطأ في النظام❌ ساعدني!!❌ لا يعمل❌ سؤال حول XOOPS❌ خطأإرشادات الاسم
Section titled “إرشادات الاسم”- كن محدداً - اذكر ما وأين
- كن موجزاً - أقل من 75 حرف
- استخدم الزمن الحاضر - “يظهر صفحة فارغة” وليس “أظهرت صفحة فارغة”
- أدرج السياق - “في لوحة التحكم” و”أثناء التثبيت”
- تجنب الكلمات العامة - ليس “إصلاح” أو “مساعدة” أو “مشكلة”
أفضل ممارسات وصف المشكلة
Section titled “أفضل ممارسات وصف المشكلة”أدرج المعلومات الأساسية
Section titled “أدرج المعلومات الأساسية”- ماذا - وصف واضح للمشكلة
- أين - أي صفحة أو وحدة أو ميزة
- متى - خطوات إعادة الإنتاج
- البيئة - الإصدار والنظام والمتصفح
- لماذا - لماذا هذا مهم
استخدم تنسيق الأكواد
Section titled “استخدم تنسيق الأكواد”رسالة الخطأ: `خطأ: لا يمكن العثور على المستخدم`
مقتطف الكود:```php$user = $this->getUser($id);if (!$user) { echo "خطأ: لا يمكن العثور على المستخدم";}### أدرج لقطات الشاشة
لمشاكل واجهة المستخدم، أدرج:- لقطة الشاشة للمشكلة- لقطة الشاشة للسلوك المتوقع- شرح بالحواشي
### استخدم التسميات
أضف تسميات لتصنيف:- `bug` - تقرير خطأ- `enhancement` - طلب تحسين- `documentation` - مشكلة التوثيق- `help wanted` - البحث عن المساعدة- `good first issue` - جيد للمساهمين الجدد
---
## بعد الإبلاغ
### كن مستجيباً
- تحقق من الأسئلة في تعليقات المشكلة- قدم معلومات إضافية إذا طُلب منك- اختبر الإصلاحات المقترحة- تحقق من استمرار الخطأ مع الإصدارات الجديدة
### اتبع الآداب
- كن محترماً واحترافياً- افترض النوايا الحسنة- لا تطالب بالإصلاحات - المطورون متطوعون- عرض المساعدة إن أمكن- شكر المساهمين على عملهم
---
## التوثيق ذات الصلة
- قواعس السلوك- سير عمل المساهمة- إرشادات طلب السحب- نظرة عامة على المساهمة
---
#xoops #issues #bug-reporting #feature-requests #github