مشاريع الترميز
مستودع أساسي لمشاركة مشاريع بداية مع الآخرين ومساعدتهم على النمو أيضًا!
أولا ، شكرا لأخذ الوقت للمساهمة!
يتم تشجيع جميع أنواع المساهمات وتقديرها. راجع جدول المحتويات لطرق مختلفة لمساعدة وتفاصيل حول كيفية معالجة هذا المشروع. يرجى التأكد من قراءة القسم ذي الصلة قبل تقديم مساهمتك. سيجعل الأمر أسهل بكثير بالنسبة لنا للمشرفين وتهدئة التجربة لجميع المعنيين. يتطلع المجتمع إلى مساهماتك.
وإذا كنت تحب المشروع ، ولكن ليس لديك وقت للمساهمة ، فلا بأس بذلك. هناك طرق أخرى سهلة لدعم المشروع وإظهار تقديرك ، والتي سنكون سعداء للغاية بما يلي:
- نجم المشروع
- تغريدة حول هذا الموضوع
- راجع هذا المشروع في ReadMe لمشروعك
- اذكر المشروع في Meetups المحلية وأخبر أصدقائك/زملائك
جدول المحتويات
- مدونة لقواعد السلوك
- لدي سؤال
- اريد المساهمة
- الإبلاغ عن الأخطاء
- اقتراح تحسينات
مدونة لقواعد السلوك
يحكم هذا المشروع وكل من يشارك فيه قواعد السلوك المساهمة. من خلال المشاركة ، من المتوقع أن تدعم هذا الرمز. يرجى الإبلاغ عن سلوك غير مقبول إلى <>.
لدي سؤال
إذا كنت ترغب في طرح سؤال ، نفترض أنك قد قرأت الوثائق المتاحة.
قبل أن تطرح سؤالاً ، من الأفضل البحث عن المشكلات الحالية التي قد تساعدك. في حال وجدت مشكلة مناسبة وما زلت بحاجة إلى توضيح ، يمكنك كتابة سؤالك في هذه المشكلة. يُنصح أيضًا بالبحث في الإنترنت للحصول على إجابات أولاً.
إذا كنت لا تزال تشعر بالحاجة إلى طرح سؤال وتحتاج إلى توضيح ، فإننا نوصي بما يلي:
- افتح مشكلة.
- وفر أكبر قدر ممكن من السياق بشأن ما تديره.
- توفير إصدارات المشروع والمنصة (NodeJs ، NPM ، إلخ) ، اعتمادًا على ما يبدو ذا صلة.
سنعتني بالمسألة في أقرب وقت ممكن.
اريد المساهمة
إشعار قانوني
عند المساهمة في هذا المشروع ، يجب أن توافق على أنك قمت بتأليف 100 ٪ من المحتوى ، وأن لديك الحقوق اللازمة للمحتوى وأن المحتوى الذي تساهم به قد يتم توفيره بموجب ترخيص المشروع.
الإبلاغ عن الأخطاء
قبل تقديم تقرير الأخطاء
يجب ألا يترك تقرير الأخطاء الجيدة الآخرين يحتاجون إلى مطاردةك لمزيد من المعلومات. لذلك ، نطلب منك التحقيق بعناية ، وجمع المعلومات ووصف المشكلة بالتفصيل في تقريرك. يرجى إكمال الخطوات التالية مقدمًا لمساعدتنا في إصلاح أي خطأ محتمل في أسرع وقت ممكن.
- تأكد من أنك تستخدم أحدث إصدار.
- حدد ما إذا كان الخطأ الخاص بك بالفعل خطأ وليس خطأً في جانبك على سبيل المثال باستخدام مكونات/إصدارات البيئة غير المتوافقة (تأكد من أنك قد قرأت الوثائق. إذا كنت تبحث عن الدعم ، فقد ترغب في التحقق من هذا القسم).
- لمعرفة ما إذا كان المستخدمون الآخرون قد عانوا (وربما يتم حلهم بالفعل) نفس المشكلة التي تواجهها ، تحقق مما إذا كان هناك بالفعل تقرير خطأ موجود لخطأك أو خطأك في تعقب الأخطاء.
- تأكد أيضًا من البحث في الإنترنت (بما في ذلك Stack Overflow) لمعرفة ما إذا كان المستخدمون خارج مجتمع Github قد ناقشوا المشكلة.
- جمع معلومات حول الخطأ:
- تتبع المكدس (تتبع)
- نظام التشغيل ، النظام الأساسي والإصدار (Windows ، Linux ، MacOS ، X86 ، ARM)
- إصدار المترجم ، المترجم ، SDK ، بيئة وقت التشغيل ، مدير الحزمة ، اعتمادًا على ما يبدو ذا صلة.
- ربما مدخلاتك والإخراج
- هل يمكنك إعادة إنتاج المشكلة بشكل موثوق؟ وهل يمكنك أيضًا إعادة إنتاجه مع الإصدارات القديمة؟
كيف يمكنني تقديم تقرير خطأ جيد؟
يجب ألا يبلغ عن القضايا المتعلقة بالأمان أو نقاط الضعف أو الأخطاء بما في ذلك المعلومات الحساسة لمتتبع القضية أو في أي مكان آخر من الأماكن العامة. بدلاً من ذلك ، يجب إرسال الأخطاء الحساسة عبر البريد الإلكتروني إلى <>.
نستخدم مشكلات github لتتبع الأخطاء والأخطاء. إذا واجهت مشكلة في المشروع:
- افتح مشكلة. (نظرًا لأننا لا نستطيع أن نكون متأكدين في هذه المرحلة ما إذا كان هذا خطأ أم لا ، نطلب منك عدم التحدث عن خطأ حتى الآن وعدم تسمية المشكلة.)
- اشرح السلوك الذي تتوقعه والسلوك الفعلي.
- يرجى تقديم أكبر قدر ممكن من السياق ووصف خطوات التكاثر التي يمكن لشخص آخر اتباعها لإعادة إنشاء المشكلة بمفرده. هذا عادة ما يشمل الكود الخاص بك. بالنسبة لتقارير الأخطاء الجيدة ، يجب عليك عزل المشكلة وإنشاء حالة اختبار مخفضة.
- قدم المعلومات التي جمعتها في القسم السابق.
بمجرد رفعها:
- سيقوم فريق المشروع بتسمية القضية وفقًا لذلك.
- سيحاول أحد أعضاء الفريق إعادة إنتاج المشكلة بخطواتك المقدمة. إذا لم تكن هناك خطوات استنساخ أو أي طريقة واضحة لإعادة إنتاج المشكلة ، فسوف يطلب منك الفريق هذه الخطوات وتمييز القضية على أنها
needs-repro . لن تتم معالجة الأخطاء التي تحتوي على علامة needs-repro حتى يتم إعادة إنتاجها. - إذا كان الفريق قادرًا على إعادة إنتاج المشكلة ، فسيتم تمييزها إلى
needs-fix ، وربما العلامات الأخرى (مثل critical ) ، وسيتم ترك المشكلة لتنفيذها من قبل شخص ما.
اقتراح تحسينات
يوجهك هذا القسم من خلال تقديم اقتراح تعزيز للمساهمة. سيساعد اتباع هذه الإرشادات على المشرفين والمجتمع على فهم اقتراحك وإيجاد الاقتراحات ذات الصلة.
قبل تقديم تعزيز
- تأكد من أنك تستخدم أحدث إصدار.
- اقرأ الوثائق بعناية واكتشف ما إذا كانت الوظيفة مغطاة بالفعل ، ربما عن طريق التكوين الفردي.
- إجراء بحث لمعرفة ما إذا كان قد تم اقتراح التعزيز بالفعل. إذا كان ذلك ، أضف تعليقًا إلى القضية الحالية بدلاً من فتح مشكلة جديدة.
- تعرف على ما إذا كانت فكرتك تتناسب مع نطاق وأهداف المشروع. الأمر متروك لك لتقديم قضية قوية لإقناع مطوري المشروع بمزايا هذه الميزة. ضع في اعتبارك أننا نريد ميزات ستكون مفيدة لغالبية مستخدمينا وليس مجرد مجموعة فرعية صغيرة. إذا كنت تستهدف أقلية من المستخدمين فقط ، ففكر في كتابة مكتبة الإضافات/المكون الإضافي.
كيف يمكنني تقديم اقتراح تعزيز جيد؟
يتم تتبع اقتراحات التحسين على أنها قضايا جيثب.
- استخدم عنوانًا واضحًا وصفيًا للقضية لتحديد الاقتراح.
- قدم وصفًا خطوة بخطوة للتعزيز المقترح في أكبر عدد ممكن من التفاصيل.
- صف السلوك الحالي وشرح السلوك الذي توقعت رؤيته بدلاً من ذلك ولماذا. في هذه المرحلة ، يمكنك أيضًا معرفة البدائل التي لا تعمل من أجلك.
- قد ترغب في تضمين لقطات شاشة وصور متحركة تساعدك على إظهار الخطوات أو الإشارة إلى الجزء الذي يرتبط به الاقتراح. يمكنك استخدام هذه الأداة لتسجيل صور GIF على MacOS و Windows ، وهذه الأداة أو هذه الأداة على Linux.
- اشرح لماذا سيكون هذا التحسين مفيدًا لمعظم مستخدمي المساهمة. قد ترغب أيضًا في الإشارة إلى المشاريع الأخرى التي حلتها بشكل أفضل والتي يمكن أن تكون مصدر إلهام.
