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

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

חשוב לדעת

הנה סקירה כללית מהירה של עובדות על blockly-samples שצריך לדעת כדי ליצור בקשת משיכה.

• הענף הפעיל הוא main וכל בקשות המיזוג צריכות להתבצע מול הענף הזה.
• מריצים את npm install ברמת הבסיס של blockly-samples, ולא ברמה של כל פלאגין בנפרד. ‫Blockly-samples הוא monorepo, כלומר הוא מכיל כמה חבילות באותו מאגר, והתקנה ברמת הבסיס היא חלק מתהליך העבודה לניהול ה-monorepo באמצעות Lerna.
• הקוד צריך להיות בהתאם למדריך הסגנון של JavaScript או למדריך הסגנון של TypeScript, בהתאם לשפה שבה נעשה שימוש.
• משתמשים בשליחת קומיטים לפי מוסכמות בהודעות הקומיט ובשמות של בקשות משיכה.

• כל קובץ קוד חדש צריך להתחיל בקידומת של רישיון Apache License v2.0:

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

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

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