بتل کد Battle Codeدارد باز می‌شود…

بازبینی کد

در بازبینی کد، هم‌تیمی‌ها کد همدیگر را می‌خوانند و نظر می‌نویسند. با این کلمه‌ها هم نظر بازبین را درست می‌فهمی و هم خودت نظری می‌نویسی که کمک کند و کسی را نرنجاند.

ایراد را سؤال کن: Could we…?

در بازبینی کد دستور نمی‌دهند، پیشنهاد می‌دهند. به‌جای «Rename this» می‌نویسند «Could we rename this?» یا «What do you think about…?» یا «I think this might crash». کلمه‌ی we یعنی «کد مال همه‌ی ماست» و could و might جمله را نرم می‌کنند. درباره‌ی کد حرف بزن، نه درباره‌ی آدم: «This function is long»، نه «You wrote a long function».

هشت کلمه‌ی این درس

looks good (لوکس گود): خوب به نظر می‌رسد؛ تأیید می‌کنم

look یعنی «به نظر رسیدن» و looks good یعنی «خوب به نظر می‌رسد». در بازبینی کد این رایج‌ترین جمله‌ی تأیید است: بازبین کد را خوانده و ایرادی ندیده. فاعلش (It یا This) معمولاً حذف می‌شود. شکل معروفش «Looks good to me» است که کوتاهش می‌کنند: LGTM.

The new tests are clear and the code looks good to me.

تست‌های تازه روشن‌اند و کد به نظر من خوب است.

nitpick (نیت‌پیک): ایراد خیلی ریز و سلیقه‌ای

nit یعنی تخم شپش و pick یعنی «برچیدن»؛ nitpick یعنی گشتن دنبال ریزترین ایرادها. در بازبینی کد، بازبین اول نظرش می‌نویسد «nit:» تا بگوید: این خیلی کوچک و سلیقه‌ای است (یک اسم، یک فاصله، یک غلط تایپی) و اگر درستش نکنی هم جلوی merge را نمی‌گیرم. این‌طوری نویسنده می‌فهمد کدام نظرها جدی است و کدام نه.

This is just a nitpick, but the variable name has a typo.

این فقط یک ایراد ریز است، ولی اسم متغیر غلط تایپی دارد.

request changes (ریکوئِست چِینجِز): درخواست تغییر پیش از تأیید

request یعنی «درخواست کردن» و changes یعنی «تغییرها». در گیت‌هاب بازبین سه انتخاب دارد: Comment (فقط نظر)، Approve (تأیید) و Request changes. سومی یعنی «تا این موردها درست نشود، این کد نباید merge شود». رد کردن نیست؛ دعوت به یک دور دیگر کار است. پس همراهش دقیق بنویس چه چیزی باید عوض شود و چرا.

The reviewer requested changes because the tests were missing.

بازبین درخواست تغییر داد، چون تست‌ها نوشته نشده بودند.

feedback (فیدبَک): بازخورد؛ نظر دیگران درباره‌ی کار تو

feed یعنی «خوراک دادن» و back یعنی «برگشت»؛ feedback نظری است که از دیگران به تو برمی‌گردد تا کارت را بهتر کنی. در تیم‌های برنامه‌نویسی همه از هم feedback می‌خواهند: برای کد، طراحی یا یک متن. بازخورد خوب درباره‌ی کار است، نه درباره‌ی آدم؛ و به‌جای «این بد است» می‌گوید چه چیزی را می‌شود بهتر کرد.

Thanks for the feedback, I have updated the pull request.

ممنون از بازخوردت؛ pull request را به‌روز کردم.

proposal (پرُپوزال): پیشنهاد رسمی و نوشته‌شده

propose یعنی «پیشنهاد دادن» و proposal پیشنهادی است که مرتب و با دلیل نوشته شده باشد. در پروژه‌ها، قبل از یک تغییر بزرگ، یک proposal می‌نویسند که بگوید مشکل چیست، راه پیشنهادی کدام است و چه راه‌های دیگری بررسی شده. تیم روی همان متن نظر می‌دهد و بعد کد نوشته می‌شود؛ ارزان‌تر از این است که اول کد بنویسی و بعد بفهمی کسی موافق نبود.

I wrote a short proposal for the new login flow.

برای روند تازه‌ی ورود، یک پیشنهاد کوتاه نوشتم.

draft (درَفت): پیش‌نویس؛ نسخه‌ی هنوز ناتمام

draft یعنی پیش‌نویس: نسخه‌ی اول یک نوشته که هنوز کامل نیست. در ایمیل، پیامِ نفرستاده در پوشه‌ی Drafts می‌ماند. در گیت‌هاب، draft pull request یعنی «این کد هنوز آماده نیست، ولی می‌خواهم ببینید به کدام سمت می‌روم». نوشتن هم همین‌طور است: اول یک draft بنویس، بعد کوتاه و روشنش کن.

This pull request is still a draft, please do not merge it.

این pull request هنوز پیش‌نویس است؛ لطفاً merge نکنید.

ready for review (رِدی فور ریویو): آماده برای بازبینی

ready یعنی «آماده» و review یعنی «بازبینی». وقتی کارت تمام شد، تست‌ها سبز شد و خودت یک بار کدت را خواندی، آن را ready for review اعلام می‌کنی تا هم‌تیمی‌ها نگاهش کنند. در گیت‌هاب دکمه‌ای به همین اسم، pull request را از حالت draft بیرون می‌آورد و به بازبین‌ها خبر می‌دهد.

The search page is ready for review, could you take a look?

صفحه‌ی جست‌وجو آماده‌ی بازبینی است؛ می‌شود نگاهی بیندازی؟

follow-up (فالوآپ): کار یا پیامِ بعدی که دنباله‌ی همین موضوع است

follow یعنی «دنبال کردن»؛ follow-up چیزی است که بعداً در ادامه‌ی یک کار می‌آید. در بازبینی کد وقتی می‌گویند «این را در یک follow-up درست می‌کنم» یعنی «در این pull request نه، در pull request بعدی». این‌طوری هر تغییر کوچک می‌ماند. در ایمیل هم follow-up پیامی است که برای یادآوری یا پرسیدن نتیجه می‌فرستی.

I will fix the naming in a follow-up pull request.

اسم‌گذاری را در یک pull request بعدی درست می‌کنم.

گفت‌وگو زیر یک pull request

Sara: The pull request is ready for review. It was a draft until this morning.

Ali: Thanks! The code looks good overall. Two comments:
1. nit: Could we rename "tmp" to "result"?
2. The function does not handle an empty list. I think it will crash, so I have to request changes for now.

Sara: Thanks for the feedback! I fixed both. I will add more tests in a follow-up PR.

Ali: Looks good to me. Approved!

سارا: pull request آماده‌ی بازبینی است. تا امروز صبح پیش‌نویس بود.

علی: ممنون! کد در کل خوب به نظر می‌رسد. دو نظر دارم:
۱. ایراد ریز: می‌شود اسم «tmp» را به «result» عوض کنیم؟
۲. تابع لیست خالی را در نظر نگرفته. فکر می‌کنم از کار می‌افتد، پس فعلاً باید درخواست تغییر بدهم.

سارا: ممنون از بازخوردت! هر دو را درست کردم. تست‌های بیشتر را در یک PR بعدی اضافه می‌کنم.

علی: به نظر من خوب است. تأیید شد!