הוספת פלאגין של צד ראשון

מידע נוסף על יישומי פלאגין

התהליך

יישומי פלאגין עוברים ארבעה שלבים: הצעה, דיון, הטמעה ופרסום.

הצעה

פלאגין מתחיל כהצעה. כדי להציע יישומי פלאגין, תוכלו ליצור בעיה חדשה באמצעות התבנית FeatureRequest.

ראו איך לכתוב בקשה להוספת תכונה

בנוסף למידע הבסיסי של הבקשה להוספת תכונה, הצעה לפלאגין צריכה לכלול:

  • ה-API שהפלאגין יחשוף.
  • ממשקי API שצריך להוסיף או לשנות בליבה שלBlockly כדי לתמוך בפלאגין.
  • צילומי מסך, קובצי GIF או הדמיות אם הפלאגין כולל תכונות של ממשק המשתמש.
  • הסבר למה זה צריך להיות פלאגין של צד ראשון ולא פלאגין של צד שלישי.

הצוות של blockly בודק את ההצעות ברגע שהן מגיעות, סוגר את הבעיה או מוסיף את התווית status: discuss.

קבוצת הדיון

בשלב הבא, פלאגין עובר לשלב דיון. השלב הזה כולל:

  • הבהרה לגבי הפונקציונליות הרצויה.
  • הבהרת ה-API של הפלאגין.
  • תכנון לקראת יישום.
  • תכנון מבחנים.
  • דיון על שינויים ב-API ב-Blockly.
  • פיצול יישומי פלאגין גדולים לשלבי הטמעה.
  • מתן שמות ליישומי פלאגין, על סמך מוסכמות מתן השמות שלנו.
  • אישור עמידה בכל הקריטריונים מאינטראקציה ישירה.

הדיון הזה מתרחש בדרך כלל בבעיה ב-GitHub. ככל שההיקף של הפלאגין קטן יותר, כך שלב הדיון יכול להיות מהיר יותר. יישומי פלאגין גדולים יותר עשויים למשוך את תשומת הלב של הקהילה ולהעניק דעות מקיפות לגבי הפתרון הנכון. אם זה קרה לגבי הבעיה שלכם, נהדר! מצאתם משהו שמעניין אנשים.

המטרה היא שבסוף שלב הדיון התקבלו כל ההחלטות העיקריות לגבי עיצוב, ויש רשימה ברורה של שלבי ההטמעה. את שניהם צריך לתעד בהערות בנושא.

במהלך הדיון יכול להיות שנחליט שפלאגין צריך להיות של צד שלישי ולא לפרסם אותו בהיקף של @blockly. במקרה כזה נסביר למה הבעיה ונסגור אותה.

בסיום הדיון, אחד מחברי הצוות יוסיף לבעיה את התווית status: implementation.

הטמעה

שלבי ההטמעה כוללים:

  • הרצת npx @blockly/create-package כדי להגדיר את הפלאגין ואת הספרייה שלו מתבנית. למידע נוסף...
  • הטמעת הלוגיקה העיקרית של הפלאגין.
  • הטמעת ממשק משתמש, אם צריך.
  • בדיקת הפלאגין באמצעות מוקה.
  • תיעוד הפלאגין, כולל README.

אם לבעיה בפלאגין מופיעה התווית status: הטמעה, פירוש הדבר הוא שהיא מוכנה להטמעה או מוטמעת באופן פעיל. כדי להימנע ממאמצי כפילות, כל מי שמתעניין יוכל להגיב על הבעיה ולשאול אם הנושא עדיין פתוח להוספת תוכן.

יכול להיות שכמה תורמי תוכן יבצעו במקביל את ההטמעה. תוכלו להטמיע פלאגין בשיתוף פעולה במזלג שלכם, או באמצעות בקשות משיכה מול המאגר הזה. אם אתם רוצים לשתף פעולה ביישומי פלאגין במאגר הזה, בקשו מצוותBlockly ליצור עבורכם הסתעפות פיצ'רים.

יש להוסיף יישומי פלאגין לקובץ gh-pages/index.md בהסתעפות master של קובצי blockly-samples. לאחר מכן הם יופיעו באתר יישומי הפלאגין. יישומי פלאגין של צד ראשון צריכים להפנות לדף הבדיקה שלהם. ניתן גם להוסיף לדף הזה יישומי פלאגין של צד שלישי, והם יכולים להפנות לקישור לבחירתם, כמו הדגמה מתארחת או דף npm.

בתהליך פרסום

לבסוף, פרסום. צוות blockly משתמש ב-Lena כדי לנהל גרסאות ופרסום של כל יישומי הפלאגין.

בכל יום חמישי, מתפרסמים יישומי פלאגין שהשתנו מאז השקתם האחרונה. אם ברצונך לבצע שינוי כדי לפרסם אותו מוקדם יותר, ציינו אותו בבקשת הבקשה.

האתר של יישומי הפלאגין מתעדכן גם בכל פעם שיישומי פלאגין מתפרסמים.

יישומי פלאגין שלא מוכנים לפרסום צריכים להיות מסומנים private ב-package.json. מצב כזה עשוי לקרות אם פלאגין מסתמך על שינוי שטרם פורסם ב-coreBlockly. התוכן של CoreBlockly מתפרסם בשבוע האחרון של כל רבעון (פעם בכל שלושה חודשים).