انسخ قالب المساهمة وعدّله
استبدل العناصر النائبة وتحقق من كل أمر ورابط. رحّب بتصحيحات الوثائق وتقارير الأخطاء حتى لو لم يكن المساهم مستعدًا لتعديل شيفرة التطبيق.
# المساهمة
## قبل البدء
اقرأ README وتحقق من البلاغات الموجودة.
ناقش النهج قبل تنفيذ التغييرات الكبيرة.
## الإعداد المحلي
[بيئة التشغيل المطلوبة وأوامر الإعداد المتحقق منها]
## الإبلاغ عن خطأ
أدرج الإصدار والبيئة والخطوات والنتيجة المتوقعة والنتيجة الفعلية.
احذف الأسرار والبيانات الشخصية من السجلات.
## تقديم طلب سحب
- اشرح المشكلة والتغيير المقترح.
- حافظ على تركيز التغيير.
- شغّل [الفحوص الخاصة بالمشروع].
- حدّث الوثائق المتأثرة.
## المراجعة
[من يراجع وكيفية الرد والتوافر الواقعي]
## طرق أخرى للمساعدة
[الوثائق أو الأمثلة أو الترجمات أو التقارير القابلة لإعادة الإنتاج]اجعل الإرشادات سهلة العثور عليها
يتعرف GitHub على إرشادات المساهمة في جذر المستودع أو مجلدي docs أو .github. ضع رابطًا للملف في README أيضًا، ليتمكن قارئ مقدمة المشروع من الوصول إلى العملية مباشرة.
راجع المسار بدءًا من نقاط الدخول الفعلية للمساهمة في المستودع. إذا وُجدت عدة ملفات إرشادات، فوحّد التعليمات المتعارضة. يجب ألا يجد المساهم أمر إعداد في README وأمرًا مختلفًا غير مدعوم في دليل المساهمة.
صمم مساهمة أولى يسهل البدء بها
اختر مهمة صغيرة بنتيجة واضحة، مثل تصحيح مثال لبيئة تشغيل مدعومة. اشرح كيفية إعادة إنتاج المشكلة والسلوك المطلوب تغييره وكيفية التأكد من الإنجاز. تجنب وصف المهمة بأنها مناسبة للمبتدئين إذا كانت تعتمد على معرفة داخلية غير موثقة.
اذكر بصدق مدى توافرك للمراجعة. إذا لم تستطع التعهد بوقت للرد، فاشرح كيف يمكن للمساهمين التحقق من الحالة بدلًا من ذلك. تقلل الحدود الواضحة العمل المتروك، وهي أنفع من الوعد بدمج كل مساهمة.
أسئلة شائعة
هل يحل CONTRIBUTING.md محل README.md؟
لا. يشرح README المشروع وكيفية استخدامه. وتشرح إرشادات المساهمة كيفية اقتراح التغييرات والتحقق منها.
هل ينبغي نسخ أوامر الاختبار من مشروع آخر؟
فقط إذا كانت أيضًا الأوامر الصحيحة لمشروعك. استبدل العناصر النائبة بأوامر تحققت منها فعلًا.
هل تضمن إرشادات المساهمة المزيد من المساهمين؟
لا. تقلل الغموض للمهتمين، لكن فائدة المشروع وجودة المهام ومتابعة المشرفين تظل عوامل مهمة.