تقديم مراجعة لطلب السحب¶
نحن دائمًا سعداء بتلقي التعليقات من المساهمين، بغض النظر عن مستوى خبرتهم.
لماذا مراجعة المساهمات؟¶
يجب مراجعة كل مساهمة يتم تقديمها، بغض النظر عما إذا كانت مقدمة من أحد أعضاء الفريق الأساسيين أو من مساهم جديد. فكل شخص معرض لفقدان شيء ما. وتهدف عملية المراجعة إلى توفير شبكة أمان إضافية.
الغرض من عملية المراجعة هو ضمان أن يكون كل المحتوى، بما في ذلك الكود والوثائق، خالياً من الأخطاء وسهل الصيانة قدر الإمكان. أي شيء يمكنك القيام به لتعزيز هذا الهدف هو مساهمة مرحب بها. قد يتراوح ذلك بين شيء بسيط مثل تصحيح خطأ مطبعي، إلى العثور على حالات استثنائية في استخدام واجهة برمجة التطبيقات (API) لم يتم اكتشافها. يمكنك تحديد طرق لجعل نظام الاختبار أكثر قوة، أو تقديم اقتراحات حول طرق هيكلة البنية العامة للتغييرات بحيث يسهل صيانتها أو توسيعها.
هل يمكنني المراجعة؟¶
نعم! يمكنك تقديم مراجعة لأي طلب سحب تراه مفتوحًا على BeeWare.
بصفتك مساهمًا لأول مرة، لا تتردد في مراجعة أي طلب سحب تجده، حتى لو كان مقدمًا من أحد أعضاء الفريق الأساسي. إذا كنت مبتدئًا، فقد تفوتك بعض السياقات الأكبر للمشروع؛ لكننا نسعى إلى الحفاظ على سهولة الوصول إلى قاعدة الكود بغض النظر عن مستوى خبرتك. إذا كان هناك شيء في الكود لا يبدو منطقيًا، فقد يشير ذلك إلى الحاجة إلى مزيد من التوثيق (إما في الكود أو كوثيقة تصميم مستقلة).
المساهمة في مراجعة طلب السحب¶
تقديم مراجعة لطلب السحب
نرحب بالجميع لمراجعة أي مساهمة في مشروع BeeWare. هناك بعض الاعتبارات المهمة التي يجب معرفتها قبل البدء.
فكر قبل أن تكتب تعليقك¶
قبل الشروع في المراجعة، فكر جيدًا. بصفتنا مراجعين، يجب أن نفكر فيما إذا كانت الإجابة التي نحن على وشك إرسالها:
- صحيح. احرص دائمًا على تقديم اقتراحات ومعلومات دقيقة.
- مفيد. نحن نقدم إرشادات حول كيفية تحسين الطلب؛ يجب أن تحدد هذه الإرشادات بوضوح مصدر المشكلة أو حالة الاستخدام غير المدروسة، ومن الأفضل أن توفر مسارًا للمضي قدمًا لحل المشكلة أو تلبية المطلب.
- ملهم. الأمر متروك لنا لإلهام المؤلف لكي يرغب في العمل على التغييرات التي طلبناها.
- ضروري. من المتوقع أن يقرأ المؤلف كل ما ننشره؛ لذا يجب أن نحترم وقته وجهده بعدم النشر إلا عند الضرورة.
- اللطف. هناك طرق متعددة لتقديم نفس الملاحظات؛ علينا أن نحرص على أن تكون كلماتنا لطيفة وداعمة وبناءة.
من الممكن تمامًا التفكير، مع تقديم مراجعة فعالة في الوقت نفسه. المفاهيم التي تمت مناقشتها أعلاه لا تمنعك من الإشارة إلى أي مشكلات تجدها في العلاقات العامة. لن تتاح للمساهمين فرصة تحسين مساهماتهم إذا لم يكونوا على دراية بالمجالات التي تحتاج إلى تحسين. المهم هو أن تظل على دراية بكيفية تقديم هذه الملاحظات. حاول أن تجعل مراجعتك غير شخصية. بدلاً من "لقد ارتكبت خطأ"، يمكنك أن تقول "يمكن تحسين هذا الرمز". راجع الرمز، وليس المؤلف.
من المهم أن تتذكر تقديم ملاحظات إيجابية بالإضافة إلى تحديد المجالات التي تحتاج إلى تحسين. على سبيل المثال، إذا كانت التغييرات مفيدة بشكل خاص، أو قمت بعمل ذكي بشكل خاص، أو تعرفت على واجهة برمجة تطبيقات (API) لم تكن تعرفها من قبل، فأخبر المؤلف بذلك! لا تقلل أبدًا من تأثير الإشارة إلى شيء قام به شخص ما بشكل صحيح أو جيد، في وسط موقف حيث كل ما أشرت إليه هو مشكلات تحتاج إلى حل.
اقتراحات مراجعة GitHub¶
تحتوي واجهة مراجعة GitHub على آلية لاقتراحات التغيير، حيث يمكنك تقديم التغيير الدقيق الذي تقترحه كبديل للمحتوى الحالي. ضع في اعتبارك أنه حتى يتم قبول هذه التغييرات المقترحة والتزام بها، لن يتم إخضاعها لفحوصات ما قبل الالتزام وفحوصات linting. لذلك، يجب استخدام هذه الميزة للتغييرات الصغيرة، فكلما كان التغيير المقترح أكبر، زادت احتمالية ظهور مشكلات.