👩🏼‍🚒 🐏 👳 مراجعة التعليمات البرمجية المنهي. المراجعة التي سيتم شكرك عليها 🏊 👩🏾‍⚖️ 🚶

^{يساعدني الزنجبيل في مراجعة الكود. وعندما لا يعجبه شيء ما - أيضًا مُنهي حقيقي ،}

"مُراجع مراجعة الشفرة" ، اتصل بي أحد الزملاء ذات مرة بعد مراجعة مثمرة بشكل خاص. فمن ناحية ، استمتعت بجمهورية التشيك وكانت ممتعة. من ناحية أخرى ، تعلم زميل شيئًا جديدًا حقًا ، وهذا سمح له بكتابة كود أفضل. حتى الفوز.

بعد تغيير العمل ، تغير الزملاء أيضًا. ولكن في مكان جديد أيضًا ، بدأوا يشكرون على المراجعة. قررت معرفة السبب ووضعه على الرفوف. اتضح 11 توصية.

1. تعامل مع المراجعة باعتبارها واحدة من الأنشطة الرئيسية

إن ترك تعليقين مثل "وبعد ذلك لا يوجد ما يكفي من التدقيق الفارغ" لا يكفي. انه ضروري:

اكتشف ما يجب القيام به
افهم كيف تم ذلك
. ( , , )?
, , . — , .

2.

إن الجلوس بجانب زميل ومناقشة شيء ما ، والنظر إلى شاشة واحدة هو أمر واحد. شيء آخر هو مراجعة الرمز على github أو bitbucket. من السهل أن تسيء فهم نوايا الزميل عندما يحدث اتصال في النص. خذ عبارة "يوجد خطأ في هذا السطر". نعم ، من الواضح أن العبارة تقول أن المقالة بها خطأ. ولكن يمكن أن يقال لها بمشاعر مختلفة: الغضب ، المفاجأة ، الفرح عندما تم القبض على الخلل ولم تدخل حيز الإنتاج. أو ربما مع اللامبالاة.

قد يسيء زميلك فهم نواياك - وهذا يؤدي إلى الاستياء والتوتر في الفريق وعموما.

اجعل حياتك أسهل: خفف العبارة ، أو حولها إلى سؤال ، أو ربما أضف وجهًا مبتسمًا.

3. تخصيص الوقت

للتأكد من أن الرمز يعمل بشكل صحيح وجيد ، تحتاج إلى فهمه بالكامل. ويستغرق وقتا. تأكد من إبرازه بما فيه الكفاية. تذكر أن مراجعة أجزاء التطبيق التي لا تعرفها ستستغرق وقتًا أطول.

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

4. لا تجعل الافتراضات. يطلب

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

5. التقاط الحالات عندما تحتاج إلى الاتصال مباشرة

عادةً ، يتم إجراء المراجعات بشكل غير متزامن. حتى تتمكن من الانغماس في الشفرة وإلهاء زميلك بشكل أقل. ولكن في بعض الحالات ، من الأفضل الاتصال مباشرة (عن طريق الصعود أو الاتصال):

عندما تنفد المواعيد النهائية. ردود فعل سريعة تسرع القرارات. ولكن بدقة: مع المواعيد النهائية ، وما إلى ذلك ، كل شيء جاهز ، وستشتت التشتيت وتقلل التركيز.
الأخطاء الفادحة. قد تكون مناقشتها علنًا أمرًا محرجًا ومحبِطًا بالنسبة لشخص ما. من الأفضل التحدث شخصيًا وشرح المشكلة. ربما يكون مجرد إشراف ، أو ربما فجوة معرفية - يتم سدها الآن.
تم اختيار نهج خاطئ تمامًا. لإخبار شخص ما أنك بحاجة للتخلص من عمله ، يجب أن تكون حذرًا. من الأفضل استخدام لغة الجسد والتجويد لنقل التوضيحات دون إهانة.

حسنًا ، من المستحسن إضافة ملخص محادثة إلى نظام المراجعة.

6. اقرأ التذكرة أولاً

قد لا تتم تغطية بعض المتطلبات في طلب سحب يبدو أنه صحيح. لتجنب ذلك ، ما عليك سوى قراءة بيان المشكلة أولاً. وفي الوقت نفسه ، سيساعد ذلك في فهم ما يحدث بشكل عام في التغييرات.

7. تبرير اقتراحاتك

بعض الأخطاء (الأخطاء المطبعية ، على سبيل المثال) لا تحتاج إلى شرح. ولكن إذا كنت تقدم حلًا معماريًا بديلاً أو اسمًا آخر - فسر مزايا وعيوب كلا الخيارين. ما يبدو واضحًا لك قد لا يكون واضحًا تمامًا للآخرين.

بالإضافة إلى ذلك ، هناك مثل: "أعط الرجل سمكة ، وتطعمه يومًا. علمه أن يصطاد السمك ، وتطعمه مدى الحياة ". عندما علمت زميلًا نهجًا جديدًا ، سيكون قادرًا على استخدامه في المستقبل وكتابة التعليمات البرمجية بشكل أفضل. في الوقت نفسه ، ستتحسن جودة المشروع أيضًا كمكافأة.

8. الثناء على القرارات الجيدة

لا يجب أن تكون المراجعة قائمة بالأخطاء. إذا رأيت مكانًا جيدًا ، أو حلًا مثيرًا للاهتمام ، أو طريقة مفيدة - أخبرني بذلك. يمكن أن يؤدي تعليق موجز "قرار رائع" إلى تحسين مزاج الشخص طوال اليوم. نعم ، ولا تمدح طلبات السحب السيئة: فهي متوترة وتدمر معنى الفكرة.

9. كن مهذبا

تلميح: عبارة مثل " هل يمكننا من فضلك التخلص من أسلوب بناء التعليقات الشبكي الغبي المدمر في الدماغ؟ " نوع معين من التعليقات ، من أجل المجاملة ، إضافة "من فضلك").

10. مساعدة

إذا قمت أثناء عملية المراجعة بتحليل عدة ملفات ونتيجة لذلك وجدت حلاً بديلاً - تجاهل روابط الزميل لهذه الملفات. يمكنك حتى مع أرقام الأسطر ، إنها أكثر ملاءمة. لن يستغرق الكثير من جهودك ، ولكن يمكن للزميل توفير الكثير من الوقت.

11. أقترح ، لا تشير

عندما تقترح نهجًا مختلفًا للمراجعة - لا تخبر زميلك ، حسب الطلب ، باستخدام خيارك. جدال ودع زميلك يقرر. على الأرجح ، سيأخذ نصيحتك. وإذا لم يكن الأمر كذلك ، فماذا يمكن أن يكون السبب؟

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

هذا كل شئ. التلخيص:

اجعل العالم من حولك أفضل قليلاً. قم بعمل مراجعات جيدة.

UPD. هذه المقالة هي ترجمة مجانية لأصلتي باللغة الإنجليزية . تحويل من "ترجمة" إلى "مقال" حتى لا تربك القراء.

مراجعة التعليمات البرمجية المنهي. المراجعة التي سيتم شكرك عليها