מאגר הליבה של Blockly מכיל את הקוד שנחוץ להרצת כל אפליקציה שמבוססת על Blockly.
לידיעה
הנה סקירה כללית מהירה של עובדות לגבי הליבה של Blockly שצריך לדעת כדי ליצור בקשת תיקון (PR).
- ההסתעפות הפעילה היא develop, וכל בקשות העריכה צריכות להתבצע בהסתעפות develop.
- עליכם למלא את תבנית הבקשה ל-pull request עם המידע המבוקש.
- הקוד חייב לעמוד בדרישות של מדריך הסגנון של Google ל-TypeScript.
- כדאי להשתמש בהתחייבויות קונבנציונליות בכותרות של שמירת הודעות ובקשות משיכה.
- מחרוזות שגלויות למשתמש חייבות להופיע בקובץ
/msg/messages.js
כדי שאפשר יהיה לתרגם אותן. פחות מ-6% מהאנשים בעולם מדברים אנגלית בשפה האנגלית. - הטקסט על בלוקים צריך בדרך כלל להיות באותיות קטנות (בדיוק כמו מילות המפתח ברוב שפות התכנות).
- שמירה על תאימות לאחור. יש הרבה אפליקציות Blockly, אל תגרמו נזק לאחרים.
כל קובץ קוד חדש חייב לכלול את הקידומת של רישיון Apache v2.0:
/** * @license * Copyright <Current YYYY> Google LLC * SPDX-License-Identifier: Apache-2.0 */
ביצוע שינוי ואימות שלו
- מריצים את הפקודה
npm install
כדי להתקין את יחסי התלות. - מריצים את הפקודה
npm run start
כדי להפעיל שרת שבו פועלת סביבה לניסוי. בדף הזה תוכלו לבדוק את ההתנהגות הקיימת. מידע נוסף זמין בדף playground. - מבצעים את השינויים הנדרשים בקוד.
- אם השרת נשאר פועל, צריך לרענן כדי לראות את השינויים. אם לא, צריך להפעיל מחדש את השרת ולוודא שהקוד פועל כמצופה ושאין שגיאות או אזהרות במסוף.
- מריצים את הפקודה
npm run build
ומוודאים שאין שגיאות build. - כתיבה של בדיקות אוטומטיות. בדרך כלל אלו יהיו בדיקות mocha בספרייה
tests/mocha
, אבל יכול להיות שנבקש מכם בדיקות מסוגים אחרים. - מריצים את הפקודה
npm run format
כדי לפרמט את הקוד ולתקן כמה בעיות של שגיאות בקוד באופן אוטומטי. - מריצים את
npm test
כדי להריץ את הבדיקות האוטומטיות. הפקודה הזו מריצה גם אתeslint
. - אם יש שגיאות של איתור שגיאות בקוד, מריצים את הפקודה
npm run lint:fix
כדי לתקן את הבעיות שאפשר לתקן אוטומטית. מטפלים בשגיאות או באזהרות הנותרות של איתור שגיאות בקוד. - אם כל הבדיקות יסתיימו בהצלחה, תוכלו לפתוח יחסי ציבור נגד פיתוח עם השינויים.