مراجعات الرموز
تُعد مراجعة طلبات السحب نوعًا شائعًا من المساهمات. على الرغم من أن التكامل المستمر (CI) يضمن أن الكود يقوم بما يفترض أن يقوم به، إلا أنه ليس كافياً. هناك سمات للمساهمة لا يمكن أتمتتها: التصميم، أو بنية الكود وبنيته، أو جودة الاختبارات، أو الأخطاء المطبعية. تمثل الأقسام التالية جوانب مختلفة من عملية مراجعة التعليمات البرمجية.
سهولة القراءة
هل تعبر الشيفرة البرمجية عن مقصدها بوضوح؟ إذا كنت بحاجة إلى قضاء الكثير من الوقت في معرفة ما تفعله الشيفرة، فإن تنفيذ الشيفرة يحتاج إلى تحسين. اقترح تقسيم الكود إلى تجريدات أصغر يسهل فهمها. وكبديل، وكمرجع أخير، يمكنهم إضافة تعليق يشرح السبب وراء ذلك. اسأل نفسك ما إذا كنت ستتمكن من فهم الشيفرة البرمجية في المستقبل القريب، دون أي سياق محيط مثل وصف طلب السحب.
طلبات السحب الصغيرة
من الصعب مراجعة طلبات السحب الكبيرة ومن السهل إغفال التفاصيل. إذا أصبح طلب السحب كبيرًا جدًا ولا يمكن التحكم فيه، اقترح على المؤلف تقسيمه.
::: استثناءات المعلومات
هناك بعض السيناريوهات القليلة التي لا يمكن فيها تقسيم طلب السحب، مثل عندما تكون التغييرات متقاربة بإحكام ولا يمكن تقسيمها. في هذه الحالات، يجب على المؤلف تقديم شرح واضح للتغييرات والأسباب الكامنة وراءها.
:::
الاتساق
من المهم أن تكون التغييرات متسقة مع بقية المشروع. التناقضات تعقد الصيانة، وبالتالي يجب أن نتجنبها. إذا كان هناك نهج لإخراج الرسائل إلى المستخدم، أو الإبلاغ عن الأخطاء، فيجب أن نلتزم بذلك. إذا كان المؤلف لا يتفق مع معايير المشروع، اقترح عليه فتح مشكلة حيث يمكننا مناقشتها أكثر.
اختبارات
تسمح الاختبارات بتغيير التعليمات البرمجية بثقة. يجب اختبار التعليمات البرمجية في طلبات السحب، ويجب أن تنجح جميع الاختبارات. الاختبار الجيد هو الاختبار الذي ينتج نفس النتيجة باستمرار ويسهل فهمه وصيانته. يقضي المراجعون معظم وقت المراجعة في كود التنفيذ، لكن الاختبارات مهمة بنفس القدر لأنها كود أيضًا.
كسر التغييرات
التغييرات الكسرية هي تجربة مستخدم سيئة لمستخدمي Tuist. يجب أن تتجنب المساهمات إدخال تغييرات كاسرة ما لم تكن ضرورية للغاية. هناك العديد من الميزات اللغوية التي يمكننا الاستفادة منها لتطوير واجهة تويست دون اللجوء إلى تغيير كاسر. قد لا يكون واضحًا ما إذا كان التغيير كاسرًا أم لا. هناك طريقة للتحقق مما إذا كان التغيير معطلاً أم لا وهي تشغيل Tuist على مشاريع التجهيزات في دليل التجهيزات. يتطلب الأمر أن نضع أنفسنا مكان المستخدم ونتخيل كيف ستؤثر التغييرات عليه.