התלמוד של המפתחהתלמוד של המפתח

מסכת ביקורת הקוד

מתן ביקורת

5 הלכות

א

הצע — אל תצווה. "מה דעתך לשנות ל..." עדיף על "שנה ל...". הביקורת היא שיחה, לא פקודה.

שכן הכותב הוא בעל הקוד, ואתה אורח בביתו. האורח המצווה — לא יוזמן בפעם הבאה. ודרשו חכמים: "consider" ו-"maybe" — לשון חכמים היא.

ב

reviewer שחזר על אותה הערה פעמיים ולא הובן — האחריות עליו. עליו להסביר טוב יותר, לא לכעוס.

שכן אם לא הובנת — ייתכן שלא הסברת. ומעשה היה ב-reviewer שכתב "כבר אמרתי!" — וכותב הקוד השיב: "לא הבנתי אז, ולא הבנתי עכשיו."

ג

ביקורת שחזרה תוך דקות ספורות מפתיחת ה-PR — בחזקת ביקורת שלא נקראה. מינימום קריאה: דקה לכל עשר שורות.

ומעשה היה ב-reviewer שאישר PR של חמש מאות שורות תוך שלוש דקות. ויתמה הכותב, ויאמר: "אפשר לקרוא כל כך מהר?" ויאמר ה-reviewer: "LGTM." ולא הוסיף.

ד

אם הביקורת ארוכה מהקוד עצמו — עדיף לשבת יחד ולדבר. כמה הודעות ארוכות בגיטהאב אינן תחליף לשיחה של עשר דקות.

אמרו חכמים: שיחה פנים-אל-פנים (או בזום) פותרת ב-10 דקות מה שthread של 40 הודעות לא יפתור בשלושה ימים.

ה

reviewer שאישר קוד ולאחר מכן מצא בו באג — אינו פטור מאחריות. "אישרתי בלי לשים לב" אינה טענה.

חתימתך על PR היא עדות. ועד שחתם ולא קרא — עדותו פסולה, ואחריותו שלמה. קרא לפני שתחתום, ואם לא הספקת — אמור שלא הספקת.