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

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

עקרונות הביקורת

5 הלכות

א

הביקורת היא על הקוד — לא על הכותב. האומר "קוד גרוע" — כשר. האומר "אתה גרוע" — עובר איסור.

שנאמר: הוכח תוכיח את עמיתך — את עמיתך, לא אותו. ומעשה היה ב-reviewer שכתב "מה חשבת בכלל?" — ויקום הכותב, ויסגור את ה-laptop, ויחפש עבודה אחרת.

ב

כל הערה בביקורת חייבת להיות ספציפית ומנומקת. "זה לא טוב" — פסול. "זה לא טוב כי X, והפתרון הוא Y" — כשר ומבורך.

הערה ללא נימוק היא נטל על הכותב — עליו לנחש מה רצית, לדעת איך לתקן, ולפתור תעלומה שלא ביקש. חסוך ממנו את הסבל.

ג

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

אמרו חכמים: עיניים שניות רואות מה שעיניים ראשונות מחמיצות. ומעשה היה במפתח שמיזג ללא ביקורת — ויהי הבאג בייצור, ויהי ה-hotfix בלילה, ויהיו הסבל והחרטה.

ד

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

שכן הכותב השקיע מאמץ, וראוי שידע מה עשה נכון — לא רק מה עשה עקום. ודרשו חכמים: משפט אחד של שבח על כל שלושה של ביקורת — זה היחס הכשר.

ה

הערות סגנון ועיצוב — יש להפרידן מהערות לוגיקה ואבטחה. קריטי ולא-קריטי אינם שקולים, ויש לסמנם בבירור.

reviewer שערבב "חסר נקודה-פסיק" עם "יש כאן חור אבטחה" — גרם לכותב לא לדעת מה דחוף. השתמש ב-nit: לפני הערות קטנות, ושמור את הדגש לדברים שבאמת חשובים.