مراجعات الكود والتواصل في طلبات السحب
كتابة أوصاف طلبات السحب وتعليقات مراجعة الكود
8 دقيقة للقراءة
طلبات السحب ومراجعات الكود هي حيث يتواصل المطورون أكثر كتابةً. الإنجليزية الواضحة والاحترافية في الـ PRs تجعلك تتميز.
قالب وصف طلب السحب
## What (ماذا)
وصف موجز لما يفعله هذا الـ PR
## Why (لماذا)
الدافع — ما المشكلة التي يحلها؟
## How (كيف)
النهج التقني المتبع
## Testing (الاختبار)
كيف تحققت أنه يعمل
مراجعة الكود — تقديم الملاحظات
عبارات الموافقة
"LGTM! Clean implementation." — يبدو جيداً! تنفيذ نظيف
"Approved. Nice refactoring." — موافق. إعادة هيكلة جيدة
طلب تغييرات (بأدب)
"Nit: Could we rename this variable?" — ملاحظة صغيرة: هل يمكن إعادة تسمية هذا المتغير؟
"Suggestion: Consider using a Map here." — اقتراح: فكر في استخدام Map هنا
"Question: What happens if the user passes null?" — سؤال: ماذا يحدث لو مرر المستخدم null؟
الإشارة إلى مشاكل
"Bug: This will throw if 'user' is null." — خطأ: هذا سيرمي استثناء لو كان 'user' فارغاً
"Security concern: SQL injection risk." — مخاوف أمنية: خطر حقن SQL
"Performance: This is O(n²)." — أداء: هذا O(n²)
الرد على ملاحظات المراجعة
"Good catch! Fixed." — ملاحظة جيدة! أُصلح
"Agreed, refactored as suggested." — أوافق، أُعيد هيكلته كما اقتُرح
"I considered that, but chose X because [reason]." — فكرت في ذلك لكن اخترت X بسبب [سبب]
"I'll address this in a follow-up PR." — سأعالج هذا في PR لاحق
اختصارات مراجعة الكود الشائعة
| الاختصار | المعنى | العربية |
|---|---|---|
| LGTM | Looks Good To Me | يبدو جيداً لي |
| PTAL | Please Take A Look | الرجاء إلقاء نظرة |
| WIP | Work In Progress | عمل قيد التنفيذ |
| Nit | Nitpick | ملاحظة صغيرة جداً |
| IMO | In My Opinion | في رأيي |
| FYI | For Your Information | للعلم |
:::