پث‌وایز

آموزش گیت و گیتهاب از صفردرس ۱۱ از ۱۲

آموزش پول ریکوئست و کد ریویو در گیت‌هاب

یاد بگیر چطور توی گیت‌هاب پول ریکوئست باز کنی، کدها رو با تیمت بررسی کنی، با کامیت‌های جدید بازخوردها رو برطرف کنی و تغییرات رو با خیال راحت مرج کنی.

چیزی که از این درس می‌بری

  • پول ریکوئست (PR) یه گفت‌وگوی تیمی ساختاریافته روی گیت‌هابه برای بررسی برنچ قبل از مرج شدن توی main.
  • چرخه‌ی کار: برنچ گرفتن از main ← کامیت ← پوش روی گیت‌هاب ← باز کردن PR ← رفع کامنت‌ها با کامیت‌های جدید ← مرج.
  • PRها رو همیشه کوچیک و متمرکز روی یه هدف نگه دار، بگو چرا تغییر انجام شده و issueهای مرتبط رو لینک کن.
فهرست این درس۷
  1. پول ریکوئست چیه؟
  2. چرخه‌ی کامل یه پول ریکوئست
  3. آناتومی یه پول ریکوئست عالی
  4. PR کوچیک در برابر PR غول‌پیکر
  5. فورک (Fork)
  6. وضعیت‌های بازبینی و تأیید در گیت‌هاب
  7. مرور درس

۰۱ایده‌ی اصلی

پول ریکوئست چیه؟

پول ریکوئست به هم‌تیمی‌هات می‌گه: «من این ویژگی رو روی برنچم تموم کردم—لطفاً بررسیش کنین و بیارینش توی main.» خود گیت دستوری برای PR نداره؛ پول ریکوئست قابلیتی در گیت‌هابه که روی برنچ‌های گیت ساخته شده و کل diff تغییراتت رو توی یه نمای شفاف نشون می‌ده.

سارا یه برنچ به اسم navbar-search می‌سازه، ۳ تا تغییر رو کامیت می‌کنه، روی گیت‌هاب پوش می‌کنه و روی «New pull request» کلیک می‌کنه. حالا کل تیم می‌تونن تغییرات دقیق خط‌به‌خطش رو ببینن و کامنت بذارن.

۰۲قدم‌به‌قدم

چرخه‌ی کامل یه پول ریکوئست

  1. ۱. ساخت برنچ از روی main

    برای یه کار مشخص یه برنچ بساز: git checkout -b feature-signup.

  2. ۲. کامیت و پوش

    کامیت‌های متمرکزت رو به‌صورت محلی بزن، بعد برنچ رو پوش کن: git push -u origin feature-signup.

  3. ۳. باز کردن PR در گیت‌هاب

    برنچ خودت رو به‌عنوان مبدا و main رو به‌عنوان مقصد انتخاب کن. یه توضیح کوتاه هم بنویس که چی تغییر کرده و چرا.

  4. ۴. بازبینی و گفت‌وگو

    هم‌تیمی‌هات diff رو می‌خونن، سؤال می‌پرسن، پیشنهاد بهبود می‌دن یا تغییرات رو تأیید می‌کنن.

  5. ۵. به‌روزرسانی با کامیت‌های جدید

    نیاز به اصلاح داری؟ تغییرات رو محلی اعمال کن و روی همون برنچ پوش کن. PR خودکار آپدیت می‌شه.

  6. ۶. مرج و تمیزکاری

    وقتی تأیید شد، توی main مرجش کن و برنچ ویژگی رو پاک کن تا مخزن تمیز بمونه.

خودت رو امتحان کنسؤال ۱ از ۴

سارا برای فرم لاگین یه PR باز کرده. بازبین ازش می‌خواد یه غلط املایی رو درست کنه و اعتبارسنجی ورودی اضافه کنه. سارا باید چیکار کنه؟

  1. PR رو ببنده، برنچ رو پاک کنه و از اول با یه PR کاملاً جدید شروع کنه
  2. اصلاحات رو محلی انجام بده، کامیت کنه و روی همون فیچر برنچ پوش کنه
  3. تغییرات رو با فورس مستقیم روی برنچ main پوش کنه تا فرآیند بازبینی رو دور بزنه
  4. فایل‌های تغییرکرده رو مستقیم برای بازبین ایمیل کنه تا دستی مرجشون کنه
جواب رو ببین

اصلاحات رو محلی انجام بده، کامیت کنه و روی همون فیچر برنچ پوش کنه

دقیقاً. هیچ‌وقت برای به‌روزرسانی نیازی به PR جدید نداری. هر کامیت جدیدی که روی همون برنچ پوش بشه، خودکار توی PR باز نشون داده می‌شه.

۰۳بهترین روش‌ها

آناتومی یه پول ریکوئست عالی

یه PR عالی برای وقت بازبین ارزش قائله. فقط یه کار مشخص انجام می‌ده، توضیح کوتاهی داره که می‌گه چرا این تغییر انجام شده (نه فقط چی)، و با عباراتی مثل Fixes #42 به issueای که حل می‌کنه لینک می‌شه تا گیت‌هاب بعد از مرج، تیکت رو خودکار ببنده.

عنوان: «رفع لوپ ریدایرکت در ریست پسورد». توضیحات: «وقتی توکن منقضی می‌شد، کاربر توی لوپ رفرش گیر می‌کرد. این تغییر کاربر رو با یه پیام خطای toast به /login ریدایرکت می‌کنه. Fixes #104».

PR کوچیک در برابر PR غول‌پیکر

PR متمرکز و کوچیک

۲۰ تا ۸۰ خط رو تغییر می‌ده. فقط یه مشکل رو حل می‌کنه. بررسیش ۵ دقیقه طول می‌کشه، سریع تأیید می‌شه و اگه مشکلی پیش بیاد خیلی تمیز rollback می‌شه.

PR غول‌پیکر ۲،۰۰۰ خطی

یه باگ رو رفع می‌کنه، فوتر رو از اول طراحی می‌کنه، سیستم auth رو ریفکتور می‌کنه و ۱۰ تا کتابخونه رو آپدیت می‌کنه. هیچ‌کس نمی‌تونه عمیق بررسیش کنه؛ باگ‌ها داخلش مخفی می‌شن و بازبینی هفته‌ها طول می‌کشه.

خودت رو امتحان کنسؤال ۲ از ۴

کاوه باگ دکمه‌ی پرداخت رو درست کرده. همون موقع کل ماژول checkout رو reformat کرده، رنگ سبد خرید رو هم عوض کرده و همه رو توی یه PR فرستاده. این کار خوبیه چون توی وقت صرفه‌جویی می‌کنه.

  1. درست
  2. نادرست
جواب رو ببین

نادرست

غلطه. قاطی کردن رفع باگ با تغییرات ظاهری یا تغییرات حجیم فرمت‌بندی، بازبینی کد رو سخت و خطرناک می‌کنه. اگه رفع مشکل پرداخت درست کار کنه ولی بازطراحی checkout باگ داشته باشه، کل PR گیر می‌کنه. این‌ها رو توی برنچ‌ها و PRهای جداگونه تقسیم کن.

فورک (Fork)

قابلیت گیت‌هاب · دنیای متن‌باز

یه کپی کامل و شخصی از ریپازیتوری گیت‌هاب دیگران روی اکانت خودت. فورک بهت اجازه می‌ده وقتی دسترسی نوشتن (write) به پروژه‌ی اصلی نداری، آزادانه تغییراتت رو بدی و برنچ‌ها رو پوش کنی، بعد از طریق پول ریکوئست کارت رو بهشون پیشنهاد بدی.

می‌خوای یه غلط املایی رو توی مستندات رسمی React درست کنی. روی گیت‌هاب روی «Fork» کلیک می‌کنی، فورک خودت رو روی لپ‌تاپت کلون می‌کنی، یه برنچ می‌سازی و روی فورکت پوش می‌کنی؛ بعد یه PR به سمت ریپازیتوری رسمی فیسبوک باز می‌کنی.

خودت رو امتحان کنسؤال ۳ از ۴

هر رفتار رو توی دسته‌ی عادت سالم PR یا ضدالگوی تیمی قرار بده:

عادت سالم در PRضدالگوی تیمی

  • نوشتن یه توضیح شفاف که بگه چرا این تغییر لازمه
  • یه PR با ۱،۵۰۰ خط کد که ۳۰ تا فایل رو توی ۳ تا فیچر مختلف تغییر داده
  • لینک کردن PR به سیستم ثبت issue با «Fixes #58»
  • مرج کردن فوری PR خودت بدون این‌که منتظر بازبینی بمونی
  • پوش کردن کامیت‌های جدید روی برنچ PR برای برطرف کردن کامنت‌های بازبینی
  • فرمت کردن هزاران خط کد نامربوط وسط یه باگ‌فیکس سریع
جواب رو ببین

عادت سالم در PR: نوشتن یه توضیح شفاف که بگه چرا این تغییر لازمه, لینک کردن PR به سیستم ثبت issue با «Fixes #58», پوش کردن کامیت‌های جدید روی برنچ PR برای برطرف کردن کامنت‌های بازبینی

ضدالگوی تیمی: یه PR با ۱،۵۰۰ خط کد که ۳۰ تا فایل رو توی ۳ تا فیچر مختلف تغییر داده, مرج کردن فوری PR خودت بدون این‌که منتظر بازبینی بمونی, فرمت کردن هزاران خط کد نامربوط وسط یه باگ‌فیکس سریع

وضعیت‌های بازبینی و تأیید در گیت‌هاب

  • بازبین‌ها می‌تونن روی خط‌های مشخصی از کد کامنت بذارن، PR رو تأیید (approve) کنن یا قبل از مرج درخواست تغییر (request changes) بدن.
  • گیت‌هاب بررسی‌های خودکار (تست‌ها، لینترها) رو روی هر کامیتی که به برنچ PR پوش بشه اجرا می‌کنه.
  • اگه برنچت از main عقب افتاده باشه، گیت‌هاب بلافاصله کانفلیکت‌های مرج رو نشون می‌ده.
  • وقتی تمام چک‌ها پاس بشن و تأییدیه‌ها برسن، کلیک روی «Merge pull request» برنچ رو با main یکی می‌کنه.

خودت رو امتحان کنسؤال ۴ از ۴

هر مفهوم همکاری در گیت‌هاب رو به کارکرد واقعیش وصل کن:

  • پول ریکوئست (Pull Request)
  • فورک (Fork)
  • درخواست تغییر (Request Changes)
  • Fixes #12

صفحه‌ی گفت‌وگو در گیت‌هاب برای بررسی و تست تغییرات برنچ قبل از مرجوضعیت بازبینی که تا برطرف نشدن ایرادهای مشخص، جلوی مرج شدن رو می‌گیرهکپی از ریپازیتوری دیگران روی اکانت خودت وقتی دسترسی نوشتن ندارییه کلمه‌ی کلیدی جادویی توی توضیحات PR که موقع مرج شدن، issue رو خودکار می‌بنده

جواب رو ببین
  • پول ریکوئست (Pull Request) → صفحه‌ی گفت‌وگو در گیت‌هاب برای بررسی و تست تغییرات برنچ قبل از مرج
  • فورک (Fork) → کپی از ریپازیتوری دیگران روی اکانت خودت وقتی دسترسی نوشتن نداری
  • درخواست تغییر (Request Changes) → وضعیت بازبینی که تا برطرف نشدن ایرادهای مشخص، جلوی مرج شدن رو می‌گیره
  • Fixes #12 → یه کلمه‌ی کلیدی جادویی توی توضیحات PR که موقع مرج شدن، issue رو خودکار می‌بنده

۰۷جمع‌بندی

مرور درس

  • پول ریکوئست (PR) یه گفت‌وگوی تیمی ساختاریافته روی گیت‌هابه برای بررسی برنچ قبل از مرج شدن توی main.
  • چرخه‌ی کار: برنچ گرفتن از main ← کامیت ← پوش روی گیت‌هاب ← باز کردن PR ← رفع کامنت‌ها با کامیت‌های جدید ← مرج.
  • PRها رو همیشه کوچیک و متمرکز روی یه هدف نگه دار، بگو چرا تغییر انجام شده و issueهای مرتبط رو لینک کن.
  • موقع مشارکت توی پروژه‌های متن‌باز یا ریپازیتوری‌های دیگران که بهشون دسترسی نوشتن نداری، از فورک (Fork) استفاده کن.
  • هیچ‌وقت PRهای غول‌پیکری نساز که رفع باگ رو با ریفکتور قاطی می‌کنن؛ PRهای کوچیک به تیم سرعت و امنیت می‌دن.

به سبک خودت یادش بگیر.

توی اپ از یادآی بخواه این درس رو ساده‌تر توضیح بده، از زندگی خودت مثال بزنه یا عمیق‌تر بره. بعد یه مسیر کامل دور هدف خودت بساز.

Cafe Bazaar Myket توی اپ شخصی‌سازیش کن