שיתוף דוגמאות

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

חשוב לדעת

ריכזנו כאן עובדות מהירות על blockly-samples שצריך לדעת כדי ליצור בקשת תיקון (PR).

  • ההסתעפות הפעילה היא master, וכל בקשות העריכה צריכות להיעשות בהסתעפות הזו.
  • מריצים את npm install ברמת הבסיס של blockly-samples,ולא ברמת הפלאגין הספציפי. Blockly-samples הוא מונו-מאגר, כלומר הוא מכיל כמה חבילות באותו מאגר, וההתקנה ברמת הבסיס היא חלק מתהליך העבודה לניהול המונו-מאגר באמצעות Lerna.
  • הקוד צריך לעמוד בדרישות של מדריך הסגנון של JavaScript או של מדריך הסגנון של TypeScript, בהתאם לשפה שבה נעשה שימוש.
  • כדאי להשתמש בהתחייבויות רגילות בהודעות ההתחייבות ובשמות של בקשות משיכה.
  • כל קובץ קוד חדש חייב לכלול את הקידומת של רישיון Apache v2.0:

    /**
     *   @license
     *   Copyright <Current YYYY> Google LLC
     *   SPDX-License-Identifier: Apache-2.0
     */
    

ביצוע שינוי ואימות שלו

  1. כדי להתקין את יחסי התלות, מריצים את npm install ברמת הבסיס (root) של blockly-samples.
  2. מריצים את npm run start בספרייה של הפלאגין כדי ליצור ולהפעיל שרת שבו פועל דף הבדיקה של הפלאגין. אפשר להשתמש בדף הזה כדי לראות את ההתנהגות הקיימת של פלאגין, או אם מוסיפים פלאגין חדש, צריך להפוך אותו לדף בדיקה שימושי כדי שאנשים אחרים יוכלו לראות מה הפלאגין עושה. מידע נוסף זמין בדף playground.
  3. מבצעים את השינויים הנדרשים בקוד של הפלאגין.
  4. אם השרת פועל, השינויים ייטענו באופן אוטומטי. אחרת, מפעילים מחדש את השרת ומוודאים שהתוסף פועל כצפוי ושאין שגיאות או אזהרות במסוף.
  5. מריצים את הפקודה npm run build ומוודאים שאין שגיאות build.
  6. כותבים בדיקות mocha אוטומטיות בספרייה test/.
  7. מריצים את npm run test כדי להריץ את הבדיקות האוטומטיות.
  8. מריצים את npm run lint:fix כדי לתקן שגיאות איתור שגיאות בקוד. מטפלים בכל האזהרות או השגיאות שנותרו.
  9. מריצים את npm run format כדי להריץ את הפורמט האוטומטי.
  10. אם כל הבדיקות יעברו, תוכלו לפתוח בקשת תיקון (PR) עם השינויים שלכם ב-master.