בדיקות קוד

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

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

הסיבה העיקרית לגישה הזו היא שאנחנו רוצים שכותבי יחסי ציבור ילמדו להיות שותפים ביצירת התוכן XLA. אם הבודקים מתקנים בעיות ב יחסי הציבור, למחברים קשה יותר ללמוד. הגישה של XLA יכולה להיות מאתגרת גם לבודקים וגם לכותבים, אבל אנחנו מאמינים שהיא עוזרת לנו להרחיב את הקהילה.

ללמוד להיות 'שותף ביצירת XLA באופן מלא' לא מספיק לכתוב קוד ללא באגים. יש עוד הרבה מה ללמוד על תרומה לתוכן XLA. האיסור הזה כולל:

  • סגנון תכנות
  • כיסויי קצה שכדאי לשים לב אליהם
  • ציפיות לגבי מבחנים בכתיבה
  • ציפיות לגבי תגובות ותיאורי יחסי ציבור
  • ציפיות לגבי בניית תשתית כדי לתמוך בשינויים שלכם

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

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

  • קראו בעיון את PR ו/או בקשו מקולגה שלכם לבדוק אותו לפני שתשלחו אותו: נסו להסיר טעויות טריוויאליות (שגיאות בסגנון קוד, איות ודקדוק וכו') לפני שתשלחו את ה-PR לבדיקה. ודאו שכל הבדיקות עברו בהצלחה.
  • קראו בעיון את ההערות של כותב הביקורת: לפני שאתם שולחים גרסה חדשה, נסו להבין מה הכותב מבקש ולנסות להתייחס לכל התגובות.
  • הימנעו מדיונים שמשיקים אותם (רכיבה על אופניים): דיונים טכניים ומחלוקות הן בעלות ערך רב ואף אחד לא מושלם. עם זאת, הימנעו מדיונים שאינם מועילים או סגנוניים בלבד. אם לא הסכמת עם הערה של כותב הביקורת, כדאי לפרט את הסיבות בצורה מדויקת ומקיפה ככל האפשר כדי להימנע מדיונים חוזרים וממושכים.
  • אל תשאלו את 'שאלות נפוצות בנושא ביקורות', המפורטות למטה: פירטנו בהמשך כמה תשובות לשאלות נפוצות ואת הנימוקים שלנו.

באופן כללי, אנחנו מזמינים אתכם לנסות לצמצם ככל האפשר את הזמן הנדרש לבדיקת אנשי הקשר. לאחר מכן נוכל לבדוק את השינויים במהירות!

תודה על התרומה שלך ל-XLSA, ובהצלחה בפריצה!

שאלות נפוצות בנושא בדיקה

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

יכול להיות שכותבי הביקורות של XLA יבקשו מכם לבנות תשתית כלשהי (או לבצע שינוי גדול ב יחסי הציבור) בצירוף יחסי ציבור שכתבת. יכול להיות שהבקשה הזו נראית לא נחוצה או אנלוגית לשינוי שאתם מנסים לבצע. סביר להניח שהסיבה לכך היא חוסר התאמה בין הציפיות שלכם לגבי כמות האינפרה שאתם צריכים לבנות לבין הציפיות של הבודקים.

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

"האם אוכל להתייחס לתגובה שלך בתקשורת עתידית?"

שאלות נפוצות לגבי בקשות תשתיות (או בקשות גדולות אחרות) במחלקת יחסי הציבור היא האם השינוי חייב להתבצע ב יחסי הציבור המקוריים או האם ניתן לעשות זאת כהמשך של יחסי הציבור בעתיד.

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

יש כמה סיבות לכך שחברת XLA נוקטת בגישה הזו.

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

  • השפעה על מפתחים אחרים: אם שלחתם יחסי ציבור שעוסקים בחלק מסוים של XLA, יש סיכוי טוב שאנשים אחרים מתעניינים באותו חלק. אם נקבל חוב טכני ב-PR, כל מי שיעיין בקובץ יושפע מהחוב עד שתשלחו את טופס הבקשה להמשך טיפול.

  • רוחב הפס של הבודקים: דחייה של שינוי להמשך הטיפול גורמת לעלויות רבות על הבודקים שכבר עמוסים מדי. סביר להניח שהבודקים ישכחו את הנושא של איש הקשר הראשון בזמן ההמתנה להמשך הבדיקה, וכך יהיה קשה יותר לבצע את הבדיקה הבאה. בנוסף, הבודקים יצטרכו לעקוב אחרי מעקבים צפויים ולוודא שהם אכן קורים. אם ניתן לבצע את השינוי כך שהוא יהיה מאוזן באמת ליחסי הציבור המקורי כדי שבודק אחר יוכל לבדוק אותו, רוחב הפס יהיה פחות בעייתי. מניסיוננו, זה קורה רק לעיתים רחוקות.