🌟 إرشادات المساهمة في كوكب Kawkab

نحن نرحب بالمساهمات في جميع مشاريع كوكب Kawkab. قبل المساهمة، يرجى قراءة هذه الإرشادات بعناية.

طرق المساهمة

البرمجة ليست الطريقة الوحيدة للمساهمة. إليك بعض الطرق الأخرى للمساهمة في المشروع والمجتمع:

• إصلاح الأخطاء الطباعية في الوثائق
• تحسين الوثائق الحالية
• كتابة مقالات تعليمية أو تدوينات لزيادة الوعي بين الأعضاء
• المساعدة في تصنيف المشكلات
• مشاركة رأيك في المشكلات الحالية
• المساعدة في المجتمع عبر Discord أو منتدى المناقشات
• الإبلاغ عن الأخطاء

الإبلاغ عن الأخطاء

عادةً ما تكون العديد من المشاكل التي يتم الإبلاغ عنها في المشاريع مفتوحة المصدر عبارة عن أسئلة أو أخطاء في الإعداد من جانب المستخدم. لذلك نوصي بشدة بالتحقق من المشكلة بشكل صحيح قبل الإبلاغ عنها.

كيفية الإبلاغ عن مشكلة:

• مشكلة مثالية: تقوم بعزل الخطأ الأساسي. تقوم بإنشاء اختبار فاشل داخل المستودع وفتح مشكلة على GitHub حوله.
• مشكلة جيدة: تقوم بعزل الخطأ الأساسي وتوفير إعادة إنتاج بسيطة له على مستودع GitHub.
• مشكلة معقولة: تقوم بتحديد المشكلة بشكل صحيح وتشارك الشيفرة البرمجية التي تسببت في المشكلة.

البدء في المساهمة

إذا كنت ترغب في تقديم مساهمة من خلال “طلب سحب” (Pull Request)، يفضل أن تبدأ بمناقشة لفهم المشروع بشكل أكبر قبل البدء في العمل على الشيفرة البرمجية.

• إذا كنت تصلح خطأ: يجب أن يكون الطلب قد تم تأكيد الخطأ.
• إذا كنت تضيف ميزة جديدة: يرجى شرح سبب الحاجة لهذه الميزة.

إعداد المستودع

للبدء، قم بتقليد المستودع إلى جهازك المحلي:

git clone <REPO_URL>
npm install

لتشغيل الاختبارات:

npm test

الأدوات المستخدمة

إليك الأدوات التي يتم استخدامها في جميع المشاريع:

تنسيق الكود

قبل دفع الشيفرة إلى المستودع، تأكد من تنسيقها باستخدام الأدوات التالية:

• لتنسيق الكود باستخدام Prettier:

npm run format

• لفحص الكود باستخدام ESLint:

npm run lint

كيف تحصل على التقدير كمساهم

نحن نعتمد على GitHub لعرض جميع المساهمين في المستودع. إذا كانت مساهمتك كبيرة، سيتم تضمين اسمك في سجل الإصدارات.