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