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

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

חשוב לדעת

הנה סקירה כללית מהירה של עובדות לגבי הליבה של Blockly שצריך לדעת כדי ליצור בקשת תיקון (PR).

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

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

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

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