מתן שם לפרויקט הקשור לבזל

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

אם אתם בונים כלי הקשור לבזל או משתפים את הכללים שלכם ב-Skylark, מומלץ ליישם את ההנחיות הבאות לגבי שם הפרויקט:

כללי מתן שמות לסטארלארק

ראה פריסת כללים חדשים של Starlark במסמכים.

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

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

יש לפעול לפי ההנחיות הבאות לגבי מתן שמות לכלים של Bazel:

  1. יש להעדיף לא להציג שם מותג חדש: "בזל" הוא כבר מותג חדש למשתמשים שלנו, כדאי להימנע מבלבול עם יותר מדי שמות חדשים.

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

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

  4. אין צורך להשתמש בעיצוב פרחוני או אוכל "בזל" מתעוררתריחן, הצמח. אתם לא צריכים לחפש שם שהוא צמח, מזון או מוצר הקשור ל "ריחן".

  5. אם הכלי שלכם קשור למותג אחר של צד שלישי, השתמשו בו רק כתיאור: לדוגמה, עדיף להשתמש ב-"Bazel migrator for Cmaker" במקום "CMake Bazel grgrator".

הנחיות אלה חלות גם על כתובת ה-URL של מאגר GitHub. קריאת כתובת ה-URL של המאגר צריכה לעזור לאנשים להבין מה הכלי עושה. כמובן, שם המאגר יכול להיות קצר יותר, והוא חייב להשתמש במקפים במקום ברווחים ובאותיות קטנות.

דוגמאות לשמות טובים:

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

דוגמאות לשמות שכדאי להימנע מהם:

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

הערה: ההמלצות האלה תואמות להנחיות ש-Google משתמשת בהן בקוד פתוח של פרויקט.