دليل المساهم
قبل أن تكتب الكود، اقرأ القواعد. هكذا نعمل معًا على Babelize Elements.
Before you code, read the rules.
Eight rules for contributing to Babelize Elements. Also available as a PDF.
01 · تحدّث قبل أن تكتب الكود
وجدت خللًا؟ لديك فكرة؟ تريد بناء ميزة؟ لا تبدأ بكتابة الكود بعد.
تجنّب تكرار العمل.
حافظ على تنسيق المساهمات.
02 · افتح pull request
طلب واحد. تغيير واحد واضح. اجعل طلبك:
مركّزًا
حُل مشكلة واحدة. اقصر تغييراتك على مشكلة أو ميزة واحدة.
واضحًا
اشرح ما الذي تغيّر ولماذا. أضف السياق، ولقطات الشاشة عند الحاجة، واربط المشكلة.
مُختبرًا
تأكد من أن كودك يعمل كما هو متوقع ولا يكسر الوظائف القائمة.
قابلًا للمراجعة
اجعله صغيرًا ونظيفًا. بلا تغييرات في التنسيق ولا إعادة هيكلة غير ذات صلة.
الطلبات الصغيرة والمركزة أسهل في المراجعة.
إنها تحافظ على سجل نظيف وتُدمج أسرع.
03 · جودة الكود
اكتب كودًا يمكن صيانته. قبل فتح طلبك:
اتبع الأنماط القائمة
حافظ على اتساق الكود مع المشروع.
اجعل المكوّنات قابلة لإعادة الاستخدام
ابنِ أجزاء مرنة وقابلة للتركيب.
استخدم تسمية متسقة
اتبع اصطلاحات التسمية.
تجنّب التبعيات الإضافية
حافظ على خفة المشروع.
عالج الحالات الحدّية
فكّر في حالات الخطأ والسيناريوهات.
أزل الكود غير المستخدم
حافظ على نظافة الكود وبساطته.
اختبر تغييراتك
تأكد من أن كل شيء يعمل.
حدّث الوثائق عند الحاجة
ساعد الآخرين على فهم تغييراتك.
مكوّن جديد؟ ابدأ من قالب المكوّن.
الوضوح > الذكاء.
اكتب الكود للبشر، لا للآلات فقط.
04 · مراجعة الطلب
الطلب ليس خط النهاية.
قد يطلب المراجعون:
تغييرات في الكود
تحسين التنفيذ أو إصلاح المشكلات.
اختبارات إضافية
أضف تغطية الاختبار أو حسّنها.
تحديثات الوثائق
حدّث الوثائق أو التعليقات أو ملفات README.
توضيح
قدّم سياقًا أو شرحًا أوضح.
مقاربات مختلفة
ناقش حلولًا بديلة.
التغذية الراجعة جزء من المساهمة.
كن منفتحًا ومتجاوبًا، وحافظ على البناء.
05 · إرشادات المجتمع
ابنِ مع الناس، لا مع الكود فقط.
كن محترمًا
عامِل المساهمين والمشرفين باحترام.
كن بنّاءً
أشِر إلى المشكلات وساعد في إيجاد الحلول.
قدّم السياق
اشرح تفكيرك.
ساعد الآخرين
شارك ما تعرفه.
ركّز النقاش
اجعل النقاشات ذات صلة.
راجع أيضًا مدونة السلوك.
الكود الجيد مهم.
والتعاون الجيد مهم أيضًا.
06 · النجمة والنسخ (Fork)
ادعم المشروع.
ضع نجمة على المستودع
النجمة تُظهر دعمك وتساعد المزيد من المطوّرين على اكتشاف Babelize Elements.
انسخ المستودع (Fork)
نسختك الخاصة للتجربة وإجراء التغييرات وفتح pull request.
git clone https://github.com/<your-username>/babelize-elements.git
cd babelize-elementsإجراءات صغيرة. أثر كبير.
لنبنِ معًا إنترنتًا أكثر شمولًا.
07 · انضم إلى المجتمع
لا تبنِ وحدك. انضم إلى Discord الخاص بـ Babelize وتوجّه إلى قناة #elements لـ:
الأسئلة
اطرح سؤالًا واحصل على المساعدة من الآخرين.
الأفكار
شارك الأفكار والمقترحات.
المساهمات
تبنَّ المشكلات وساهم فيها.
التغذية الراجعة
ساعدنا على النمو.
المشكلات
أبلغ عن الأخطاء وناقش الإصلاحات.
طلب المساعدة
عالق؟ اسأل المجتمع.
مساهمتك تبدأ بحوار.
الأفكار تنمو أسرع معًا.
08 · ابدأ المساهمة
هل أنت مستعد للبناء؟
good first issue.مصدر مفتوح. مزيد من الناس.
مستقبل أكثر عالمية. ابنِ معنا.