 |
الملخص | يتيح Discourse Code Review إمكانية مراجعة التزامات (commits) على GitHub من خلال Discourse. |
 |
رابط المستودع | https://github.com/discourse/discourse-code-review |
 |
دليل التثبيت | كيفية تثبيت الإضافات في Discourse |
الميزات
ما هو؟
توفر إضافة Discourse Code Review تكاملاً ثنائي الاتجاه مع مستودعات أكواد GitHub. تتيح لفريقك مراجعة التزامات (commits) إلى المستودع بالاستفادة من ميزات وإضافات Discourse مثل الإسناد (assign)، والهمسات (whispers)، والإشعارات، وتدفقات العمل المخصصة، وغير ذلك. تصبح كل التزام (commit) إلى المستودع موضوعاً. يتم عكس الردود على الموضوع على GitHub. التكامل ثنائي الاتجاه، مما يعني أنه يمكنك التعليق على Discourse ورؤيته في GitHub، أو التعليق في GitHub ورؤيته في Discourse.
توفر هذه الإضافة تدفق عمل قوي جداً للفِرق التي تحتاج إلى مراجعة جميع التزامات أي عدد من المستودعات.
تتيح لك التأكد من أن أعضاء الفريق المتعددين على دراية بجميع التغييرات المطبقة على المستودعات. يمكنك تحديد التزامات للمتابعة، وإسناد أعمال المراجعة، والمزيد.
ملاحظة: عند عرض موضوع يمكن اعتماده، يمكنك استخدام زر y على لوحة المفاتيح لاعتماد التزامات بشكل أسرع.
هل يمكنني رؤيته قيد العمل؟
يستخدم Discourse هذه الإضافة داخلياً لتتبع المستودعات. يمكنك رؤية مثال للجانب الخاص بـ Discourse هنا:
على GitHub، يبدو نفس الموضوع هكذا:
الإعداد
تعتمد الإضافة على Webhooks الخاصة بـ GitHub لاكتشاف المستودعات والتغييرات على المستودعات. للإعداد الأدنى، ستحتاج إلى تعيين الإعداد التالي إلى سلسلة سرية.
code review github webhook secret
بعد تعيينه على مستودع GitHub الخاص بك، اضبط Webhook مع:
عنوان الحمولة (Payload URL): https://YOUR_DISCOURSE/code-review/webhook
نوع المحتوى (Content Type): application/json
السرية (Secret): قيمة code review github webhook secret
أنواع الأحداث (Event Types):
- تعليقات الالتزامات (Commit comments)
- تعليقات المشكلات (Issue comments)
- طلبات السحب (Pull requests)
- مراجعات طلبات السحب (Pull request reviews)
- تعليقات مراجعات طلبات السحب (Pull request review comments)
- الدفعات (Pushes)
توفر الإضافة الإعدادات الإضافية التالية للموقع:
code review api username : يكون GitHub صارماً جداً فيما يتعلق بعدد طلبات API المجهولة التي يسمح بها، ويتيح لك هذا الإعداد استخدام مفاتيح حساب مستخدم Discourse لطلبات /comments و /commit. يقلل هذا بشكل كبير من احتمالات الوصول إلى حدود المعدل (rate limits).
code review catch up commits : عدد الالتزامات التي يجب “مزامنتها” وإنشاء مواضيع لها عند مواجهة مستودع جديد.
code review default parent category: اختيار فئة رئيسية افتراضية للفئات التي تنشئها الإضافة
code review pending tag: وسم يُطبق على جميع الالتزامات غير المراجعة، pending افتراضياً
code review approved tag: وسم يُطبق على الالتزامات المعتمدة، approved افتراضياً
code_review_followup_tag: وسم يُطبق على التزامات المتابعة follow-up افتراضياً
code review allow self approval: هل يُسمح للموظفين (staff) باعتماد التزاماتهم الخاصة؟
code review default mute new categories: الفئات الجديدة التي تنشئها مراجعة الكود مكتومة (muted) للمستخدمين افتراضياً
code review skip duration minutes: النقر على زر التخطي في التزام سيمنع ظهور ذلك الالتزام مرة أخرى لمدة الدقائق المحددة بهذا الإعداد.
سجل التغييرات (CHANGELOG)
قائمة المهام (TODO)
إضافات
كيف يستخدم Discourse هذه الإضافة
باختصار - صُممت هذه الإضافة لتكملة استخدام فريق Discourse لـ GitHub في مراجعة الأكواد.
مزيد من المعلومات
من @sam:
ما زلنا نستخدم طلبات السحب (PRs) باستخدام واجهة GitHub، ونحب القيام بطلبات سحب للعديد من التغييرات. لم يتغير شيء هنا. GitHub رائع، نحن نحب GitHub. لديهم تدفق عمل ممتاز للتغييرات التي لم يتم تنفيذها بعد. ومع ذلك…
تدفق عمل GitHub للتغييرات التي تم التزمت بها مباشرة إلى المستودع سيء.
المراجعة (Review) تسد فجوة لا يمكن سدّها بـ GitHub اليوم، نريد أن يراجع عضو واحد على الأقل من الفريق كل تغيير يُجرى على مستودعات git التي يملكها Discourse. إذا كنا سنستخدم واجهة GitHub المقدمة، لن يُسمح لأحد أبداً بالقيام بأي شيء سوى طلبات السحب. هذا سيؤخرنا بشكل هائل.
نحتاج إلى القدرة على التواصل بشكل خاص دون أن يعلم العالم بأكمله بشأن تغييرات معينة. على سبيل المثال: من الأفضل أن ننشر هذا التصحيح الرائع إلى
<اسم الشركة الكبير>في أقرب وقت ممكن، هل يمكنك أن تتكفل بذلك يا @sam؟نحتاج إلى القدرة على اعتماد التغييرات المنفذة أو طلب متابعة، وهذا شيء لا تقدمه واجهة GitHub.
نحتاج إلى القدرة على إسناد التزامات معينة لمستخدم. على سبيل المثال، إذا قام @sam بالالتزام ببعض الأخطاء، فمن الجيد أننا يمكننا إسناد ذلك الالتزام المحدد إليه مباشرة، ووضعه للمتابعة، ثم تتبع ما إذا تمت المتابعة أم لا.
Discourse رائع جداً في هذا الأمر المتعلق بالمحادثات، والميزات الصغيرة تحدث فرقاً كبيراً، يمكنني رؤية عندما يكون الناس يكتبون. لا أحتاج أبداً إلى تحديث الصفحات لتظهر التغييرات. الاقتباس رائع، ورفع الصور رائع، وهكذا.
Discourse جيد جداً في حالة القراءة، تحصل على ضمانات قوية جداً بأنك قراءت كل شيء مرة واحدة، مع GitHub لا أعرف أي التزامات قرأت وأيها لم أقرؤها. لدينا كفاءة مذهلة للتعامل مع سيل المعلومات.
والقائمة طويلة…
لذا تعمل المراجعة (review) كتكملة لـ GitHub، نحن نستخدم GitHub حالياً للتعامل مع التغييرات التي لم يتم تنفيذها بعد. ونستخدم المراجعة للتعامل بشكل صحيح مع التغييرات التي تم تنفيذها بالفعل.