كتابة طلب سحب جيد

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

في ما يلي الخطوات التي يمكنك اتخاذها لضمان إنشاء أفضل علاقات عامة ممكنة.

  1. إعلام الجمهور
  2. الإعداد
  3. صِغر
  4. الحفاظ على البيئة
  5. اختبار التغيير
  6. التواصل (pt2)

التواصل

قبل أن تبدأ في كتابة التعليمات البرمجية وتبدأ في كتابة التعليمات البرمجية، من المفيد التواصل مع الفريق الأساسي حتى يعرفوا ما الذي تهتم به.

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

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

بدء الإعداد

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

اجعله صغيرًا

حاول دائمًا جعل تغييراتك صغيرة ومركزًا. نفضّل كثيرًا مراجعة عدة علاقات رئيسية أصغر حجمًا بدلاً من مراجعة أحد العلاقات العامة العملاقة. بعض القواعد الجيدة:

  • حلّ مشكلة واحدة لا تحاول معالجة عدّة مشاكل في وقت واحد.
  • تقييد النطاق. يجب أن يستغرق الأمر عادةً أقل من 8 ساعات (حسب مدى معرفتك بقاعدة الترميز).
  • استخدام عمليات الإتمام: إذا كانت العلاقات العامة تبدو كبيرة بعض الشيء، قسِّم التغييرات إلى مجموعات منطقية باستخدام عمليات تنفيذ git.

الحفاظ على البيئة

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

بالإضافة إلى الاشتراك، يُرجى اتباع هذه الأدلة:

اختبار التغيير

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

  • بالنسبة إلى المكوّنات الإضافية: اكتب اختبارات mocha مبرمَجة تغطي تغييراتك.
  • على سبيل المثال أمثلة: اختبِر يدويًا جميع الوظائف المعروضة.
  • بالنسبة إلى الدروس التطبيقية حول الترميز: يمكنك تنفيذ البرنامج التعليمي الكامل في بيئة نظيفة واختبار أي نموذج رمز تقدّمه.

التواصل

هذا هو الجزء الأخير والأكثر أهمية في إنشاء علاقات عامة: كتابة الملخص.

تساعد كتابة ملخص علاقات عامة رائع المطورين الآخرين في مراجعة التغييرات التي أجريتها، مما يزيد من احتمالية قبولها بشكل أسرع!

يجب أن يتضمن الملخص أشياء مثل:

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

إذا اتّبعت نموذج العلاقات العامة عند إنشاء طلبك، من المفترض أن تكون جاهزًا لذلك. تذكر فقط أن تكون موجزًا وكاملاً قدر الإمكان.

نتمنى لك قضاء وقت سعيد في الترميز.