תרומה לקוד הליבה

מאגר הליבה של Blockly מכיל את הקוד שנדרש להרצת כל אפליקציה שמבוססת על Blockly.

חשוב לדעת

הנה סקירה כללית מהירה של עובדות לגבי ליבת Blockly שחשוב לדעת כדי ליצור בקשת משיכה.

• הענף הפעיל הוא main וכל בקשות המיזוג צריכות להיות מוגשות לענף הזה.
• צריך למלא את תבנית בקשת המיזוג במידע הנדרש.
• הקוד חייב לעמוד בדרישות מדריך הסגנון של TypeScript של Google.
• משתמשים בשליחת קומיטים לפי מוסכמות בהודעות הקומיט ובשמות של בקשות משיכה.
• מחרוזות שגלויות למשתמשים צריכות להיות בקובץ /msg/messages.js כדי שיהיה אפשר לתרגם אותן. פחות מ-6% מהאוכלוסייה בעולם דוברים אנגלית כשפת אם.
• הטקסט בבלוקים צריך להיות בדרך כלל באותיות קטנות (בדיוק כמו מילות המפתח ברוב שפות התכנות).
• שמירה על תאימות לאחור. יש הרבה אפליקציות של Blockly, אל תפגעו באחרים.

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

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

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

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