בקשות משיכה הן כמו דם החיים של מאגר. הם דואגים לכך שהכל יהיה תקין וזז. דף זה מפרט כיצד ליצור יחסי ציבור מלאים וקלים לעיון, וכך להגדיל את הסיכוי שימוזגו את יחסי הציבור.
הנה שלבים שניתן לבצע כדי ליצור את יחסי הציבור הטובים ביותר.
תקשורת
לפני שאתם מתחילים לכתוב קוד, כדאי לתקשר עם חברי הצוות של הליבה כדי שיידעו במה אתם מתעניינים.
אם יש בעיה שמעניינת אתכם, כתבו תגובה על הבעיה וציינו שאתם מתחילים לעבוד עליה. כך אנחנו יכולים לוודא שאין לנו הרבה אנשים שעובדים על אותו הדבר. אחד מחברי הצוות ישיב לכם כדי לאשר שהוא שלכם.
אם יש לכם רעיון שלא מופיעה לגביו בעיה כלשהי, תוכלו לכתוב אותו לפני שתתחילו. כך תהיה לצוות הזדמנות לדון באופן הטוב ביותר ביצירת השינוי לפני שתתחילו לפתח, וכך תחסוך עבודה בטווח הארוך.
שנתחיל להגדיר?
אם זו הפעם הראשונה שאתם תורמים ל-Blockly או ל-blockly-samples, כדאי להתחיל בדף development setup (הגדרת הפיתוח).
קטן
כדאי להשתדל שהשינויים יהיו קטנים וממוקדים. אנחנו מעדיפים לבחון כמה 'יחסי ציבור' קטנים יותר מאשר לעיין ב'יחסי ציבור ענקיים' אחד. הנה כמה כללי אצבע טובים:
- פותרים בעיה אחת. אין לנסות לפתור כמה בעיות בבת אחת.
- להגביל את ההיקף. בדרך כלל, זמן התגובה של יחסי הציבור צריך להיות פחות מ-8 שעות (בהתאם להיכרות שלכם עם בסיס הקוד).
- שימוש בהתחייבויות. אם אנשי הקשר שלכם מרגישים קצת גדולים, פצלו את השינויים לקבוצות לוגיות בעזרת התחייבויות git.
שמירה על הניקיון
מה החשיבות של סגנון הקוד? אנחנו בעניין לטווח הארוך, וסגנון עקבי מקל על התחזוקה. סגנון מתייחס לאופן שבו נותנים שמות למשתנים, אלא גם משפיע על מבנה הקוד, כתיבת הערות ועוד. כשהדבר אפשרי, אנחנו משתמשים בכלים כמו eslint כדי לבצע אוטומציה של בדיקות סגנון.
בנוסף ל-eslint, יש לפעול לפי המדריכים הבאים:
- מדריך הסגנון של Google JavaScript.
- המדריך להעברת הודעות
- הנחיות בנושא שימוש בממשקיBlockly API
- מדריך הסגנון של Codelab
בדיקת השינוי
לפני שאתם מפרסמים יחסי ציבור, כדאי תמיד לבדוק שהשינויים עובדים, כדי שלא תצטרכו לחזור ולתקן דברים מאוחר יותר. הנה כמה רעיונות לבדיקת קטגוריות שונות של פרויקטים:
- עבור יישומי פלאגין: יש לכתוב בדיקות מוקה אוטומטיות שמכסות את השינויים.
- לדוגמאות: יש לבדוק ידנית את כל הפונקציונליות המוכחת.
- ב-Codelabs: עליכם לעבור על כל המדריך בסביבה נקייה ולבדוק כל קוד לדוגמה שאתם מספקים.
תקשורת
זה החלק האחרון, שסביר להניח, החלק החשוב ביותר ביצירת יח"צ: כתיבת הסיכום.
סיכום טוב של PR עוזר למפתחים אחרים לבדוק את השינויים, וכך יש סיכוי גבוה יותר שהם יאושרו מהר יותר.
הסיכום צריך לכלול פרטים כמו:
- לאיזו בעיה קשור ה-PR שלך.
- איזה שינוי מתווסף יחסי הציבור שלכם.
- איך בדקתם את השינוי.
- כל מה שאתם רוצים שהבודקים יבחנו בו בקפידה.
- כל מידע אחר שלדעתכם הבודקים זקוקים לו.
אם תפעלו לפי תבנית ה-PR בזמן יצירת הבקשה, תהיו מוכנים להמשיך. רק זכרו להיות תמציתיים ומלאים ככל האפשר.
קידוד מהנה!