Blockly Samples מכיל תוכן נוסף שקשור ל-Blockly ולא נכלל במאגר הליבה, כולל יישומי פלאגין, סדנאות Codelab וקוד לדוגמה. פרטים נוספים על כל אחד מהם זמינים בדף מבנה המאגר.
לידיעה
הנה סקירה קצרה של עובדות על קטעים חסומים שצריך לדעת כדי ליצור PR.
- ההסתעפות הפעילה היא master, וכל בקשות העריכה צריכות להיעשות בהסתעפות הזו.
- מריצים את
npm install
ברמת הבסיס של blockly-samples,ולא ברמת הפלאגין הספציפי. בלוקים של דוגמאות הן מונו-רפו. כלומר, הן מכילות מספר חבילות באותו מאגר, והתקנה ברמה הבסיסית (root) היא חלק מתהליך העבודה של ניהול המונורפו עם Lerna. - הקוד חייב להיות תואם למדריך הסגנון של JavaScript או למדריך הסגנון של TypeScript של Google, בהתאם לשפה שבה משתמשים.
- כדאי להשתמש בהתחייבויות רגילות בהודעות ההתחייבות ובשמות של בקשות המשיכה.
כל קובץ קוד חדש חייב לכלול את הקידומת של רישיון Apache v2.0:
/** * @license * Copyright <Current YYYY> Google LLC * SPDX-License-Identifier: Apache-2.0 */
ביצוע שינוי ואימות שלו
- כדי להתקין את יחסי התלות, מריצים את
npm install
ברמה הבסיסית (root) של blockly-samples. - מריצים את
npm run start
בספרייה של הפלאגין כדי ליצור ולהפעיל שרת שבו פועל דף הבדיקה של הפלאגין. אפשר להשתמש בדף הזה כדי לראות את ההתנהגות הקיימת של פלאגין, או אם מוסיפים פלאגין חדש, צריך להפוך אותו לדף בדיקה שימושי כדי שאנשים אחרים יוכלו לראות מה הפלאגין עושה. אפשר לקבל מידע נוסף בדף מגרש המשחקים. - מבצעים את השינויים הנדרשים בקוד של הפלאגין.
- אם השרת נשאר פועל, השינויים ייטענו באופן אוטומטי. אם לא, מפעילים מחדש את השרת ומוודאים שהפלאגין פועל כצפוי ושאין שגיאות או אזהרות במסוף.
- מריצים את הפקודה
npm run build
ומוודאים שאין שגיאות build. - כתיבה של בדיקות מוקה אוטומטיות בספרייה
test/
. - מריצים את
npm run test
כדי להריץ את הבדיקות האוטומטיות. - מריצים את הפקודה
npm run lint:fix
כדי לתקן שגיאות של איתור שגיאות בקוד. מטפלים בכל האזהרות או השגיאות שנותרו. - מריצים את
npm run format
כדי להריץ את הפורמט האוטומטי. - אם כל הבדיקות יעברו, תוכלו לפתוח בקשת תיקון (PR) ב-master עם השינויים שלכם.