ما الذي يضيفه GitHub Copilot إلى عملية المراجعة

مكتمل

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

بنهاية هذه الوحدة ، ستتمكن من:

  • تحديد الميزات الرئيسية ل Copilot في مراجعات الكود.
  • اشرح كيف تفتح وحدات PRUs امكانيات المراجعة المتقدمة.
  • تعرف على الطرق المختلفة لمراجعة Copilot وتكمل المطورين وتساعدهم.

الميزات الرئيسية ل Copilot في مراجعات الكود

يقدم Copilot العديد من الميزات المصممة لتبسيط المراجعات:

  • ملخصات العلاقات العامة: يمكن ل Copilot صياغة أوصاف طلب السحب تلقائيا التي تتضمن ملخصا واضحا للتغييرات وقائمة بالملفات المتأثرة. هذا يضمن أن يبدأ المراجعون بالسياق وليس التخمين.

  • إصلاحات الأمان: مع مراجعة كود Copilot المدمجة في GitHub Code Scanning ، يتم وضع علامة على الثغرات الأمنية عبر اللغات. على سبيل المثال ، في JavaScript ، يمكن ل Copilot اكتشاف المدخلات غير المعقمة التي تم تمريرها إلى eval () والتعليق:

    "يمكن أن يؤدي eval() مع إدخال المستخدم إلى حقن التعليمات البرمجية. استبدله بمحلل آمن مثل JSON.parse ()." ثم يقدم تصحيحا مضمنا يتماشى مع إرشادات أمان المستودع الخاص بك.

  • تفسيرات سطرا بسطر: يمكن للمراجعين تمييز التعليمات البرمجية ومطالبة Copilot بشرح الوظائف ، مما يساعدهم على فهم التعليمات البرمجية غير المألوفة بسرعة.

  • صياغة التعليقات: يمكن ل Copilot إنشاء تعليقات مراجعة بناء على أفضل الممارسات أو إرشادات الفريق ، مما يجعل التعليقات واضحة وقابلة للتنفيذ.

  • المراجعات في IDE الخاص بك: بالإضافة إلى العمل مباشرة على GitHub.com ، يمكن ل Copilot أيضا مراجعة التعليمات البرمجية داخل IDE الخاص بك. يتيح ذلك للمطورين اكتشاف المشكلات وحلها قبل فتح طلب السحب ، وتسريع العملية وتقليل إعادة العمل.

فهم كيفية فتح وحدات PRUs لإمكانات المراجعة المتقدمة

تعمل وحدات PRUs على تشغيل هذه القدرات المتقدمة. على سبيل المثال ، يستخدم تعيين Copilot كمراجع علاقات عامة PRU في كل مرة ينشر فيها تعليقات. عند دمجها مع الملفات المخصصة .github/copilot-instructions.md ، تتوافق المراجعات المدعومة من PRU مع قواعد فريقك، سواء كانت تركز على سهولة القراءة أو الأمان أو الأسلوب.

Example:

بدون Copilot ، قد تتضمن العلاقات العامة تعليقات غامضة من مراجع مثل "إصلاح مشكلة الأمان هنا". بمساعدة Copilot + PRUs ، تصبح المراجعة:

"استخدام يقدم exec() ثغرة أمنية في حقن الكود. ضع في اعتبارك استبداله لتنفيذ subprocess.run() أوامر أكثر أمانا. إليك التصحيح المقترح:

ويوفر إصلاح الكود مضمن.

خمس طرق مختلفة تساعد مراجعة Copilot المطورين

سنراجع بعد ذلك كيف يمكن أن تساعدك مراجعة Copilot على العمل بشكل أكثر ذكاء مع:

  • اقتراحات مراجعة الكود
  • مراجعات Copilot عبر لغات متعددة
  • تنسيق البيانات في طلبات السحب
  • كتابة ملخصات طلب السحب الفعال
  • شرح ومراجعة الكود

استخدام اقتراحات Copilot في مراجعات التعليمات البرمجية

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

على سبيل المثال ، أثناء مراجعة ملف Ruby بمنطق متكرر ، يمكنك تمييز الأسطر ذات الصلة وطرح:

"اقترح إعادة بناء روبي أنظف لهذا الرمز المتكرر."

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

المراجعة عبر لغات متعددة

عند طلب مراجعة التعليمات البرمجية، يمكن ل Copilot تمييز المناطق التي لا تتبع أفضل الممارسات أو إرشادات الفريق تلقائيا

سيقوم Copilot بسرعة بإنشاء تحسينات تتوافق مع اصطلاحات اللغة ، مما يتيح لك تقديم ملاحظات مراجعة أقوى وأكثر دقة حتى خارج مجال خبرتك الأساسي.

لقطة شاشة لطلب سحب GitHub تعرض اقتراح رمز لاستبدال إعلان متغير بإعلان متغير قصير في برنامج Go.

تنسيق البيانات لطلبات السحب

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

مثال: يرسل مطور البرامج طلب سحب مع الجدول التالي لأوقات تحميل الصفحة. من الصعب قراءتها ولا تتبع دليل أسلوب Markdown الخاص بالفريق:

تشغيل الاختبار وقت التحميل قبل وقت التحميل بعد
1.3 1.2
1.2 1.1
1.1 0.885
1.3 1.3
1.2 0.918
المتوسط 1.22 1.0806

أثناء المراجعة ، ينشر Copilot تعليقا:

"هذا الجدول لا يتبع إرشادات Markdown الخاصة بالمستودع الخاص بك. إليك نسخة نظيفة بناء على دليل أسلوب شركتك ".

ويتضمن نسخة مصححة جاهزة لللصق في وصف العلاقات العامة:

تشغيل الاختبار وقت التحميل قبل (ثواني) وقت التحميل بعد التحديثات (بالثواني)
1 1.3 1.2
2 1.2 1.1
3 1.1 0.885
4 1.3 1.3
5 1.2 0.918
متوسط 1.22 1.0806

يمكن للمراجع قبول اقتراح Copilot بنقرة واحدة ، مما يضمن أن العلاقات العامة تتبع أسلوب الشركة دون قضاء بعض الوقت في إعادة التنسيق.

يظهر هذا Copilot الذي يعمل كمراجع تلقائي (وليس وكيل ترميز): يرى الجدول غير المنسق ، ويطبق إرشادات الشركة من .github/copilot-instructions.md، ويوفر إصدارا مصححا مضمنا.

كتابة ملخصات طلب السحب الفعالة

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

لقطة شاشة لطلب سحب GitHub تعرض مربع تعليق مع خيارات GitHub Copilot لإنشاء ملخص أو مخطط تفصيلي للتغييرات.

شرح ومراجعة الكود

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

أنت تعرف الآن ما يمكن أن يفعله Copilot عندما يتعلق الأمر بمراجعات الكود. بعد ذلك ، دعنا نرى كيفية استخدام مراجعات Copilot مباشرة على GitHub.com.