כל הפרויקטים המעולים מבוססים על משוב ממשתמשים. הצוות שלBlockly משתמש בבעיות ב-GitHub כדי לעקוב אחר משוב. בדף הזה מוסבר איך לכתוב בעיה שהמפתח יוכל לקרוא אותה ולהשיב לה בקלות. כך יש סיכוי גבוה יותר שנטפל בבקשות של התכונה או הדוח על הבאג.
עבודת הכנה
יש לכם שאלות?
אנחנו נהנים לשמוע את השאלות שלך! אבל בעיות ב-GitHub לא מאוד מתאימות להם. אם יש לכם שאלה, עברו במקום זאת לפורום למפתחים. אם תשאלו את השאלה, יש סיכוי גבוה יותר שתקבלו תשובה מהירה ויסודית כי היא מלאה במפתחים שמשתמשים ב-Blockly כבר שנים!
חיפוש כפילויות
לפני שמתחילים לכתוב כל סוג של בעיה, תמיד כדאי לבדוק אם כבר קיימת בעיה תואמת. אם מישהו כותב אותו, זה חוסך לכם את המאמץ לכתוב אותו בעצמכם! לפני שתתחילו לכתוב, חפשו כפילויות או בעיות קשורות.
- חיפוש ב-blockly-samples
- חיפוש ב-Blockly Core
- חיפוש בפורום
אם מצאתם בעיה תואמת, סמנו אותה בלייק או הוסיפו תגובה שמפרטת את דעתכם. זה חשוב במיוחד לדוחות על באגים ובקשות לתכונות. אם המפתחים רואים שהבעיה מקבלת הרבה תשומת לב, יש סיכוי גבוה יותר שיעבדו עליה!
דיווח על באג
אז לדעתך גילית באג? נהדר! אנחנו אוהבים לקבל דוחות על באגים כי אנחנו רוצים שהפרויקט הזה יהיה יציב ככל האפשר. הנה כמה פעולות שתוכלו לבצע כדי לעזור לכם לתקן את הבאג.
איסוף ראיות
ככלל, ככל שיש לבאג מידע רב יותר, כך טוב יותר. הנה כמה דברים שאולי תרצו לספק:
- צילומי מסך וקובצי GIF יכולים לעזור מאוד אם באג גורם לבעיה במראה.
- כדאי להשתמש ב-Sample Code אם באג משפיע רק על סוגים מסוימים של בלוקים, או על הגדרות של סביבות עבודה.
- אתר מתארח מומלץ כשיש בעיות ביצירת הבאג מחוץ לסביבה הספציפית שלכם.
אתר את הבעיה
יש הרבה קוד לחסום בין ספריית הליבה, יישומי הפלאגין, הדוגמאות וה-Codelabs. כדי לעזור לנו, אפשר לספר לנו בדיוק איפה הבעיה.
אם הבעיה היא בליבה, באיזה רכיב? לדוגמה, זו יכולה להיות בעיה בארגז הכלים, בבקרות של שינוי מרחק התצוגה או בבלוקים של הספרייה. השתדלו לפרט ככל האפשר.
אם הבעיה היא ב-blockly-samples, בדקו באיזה פלאגין, ב-codelab או לדוגמה הוא נמצא. אם נתקלת באותו באג בכמה מקומות, נשמח לשמוע על כך.
מיצוק את תהליך הרבייה
אפשר לתקן באג רק אם הוא חוזר על עצמו, לכן לפני שאתם שולחים בעיה, חשוב לוודא שיש לכם דרך יציבה לגרום לבאג להתרחש.
אמורה להופיע רשימה ממוספרת של שלבים שיסבירו למפתח איך לשחזר את הבאג. לדוגמה:
- פותחים את X Codelab.
- מעבר לדף Y.
- מריצים את קוד הדוגמה Z.
- מזהים את ההתנהגות הלא תקינה, שנראית כמו W.
אם הבעיה היא ב-Blockly Core, נסו לשחזר אותה playground.
הצעת סיבה
אם אתם חושבים שאתם יודעים מה גרם לבאג, ציינו גם את המידע הזה. שוב, רצוי לתת תשובה ספציפית ככל האפשר.
כותבים את הבעיה!
הגיע הזמן לכתוב את דוח איתור הבאגים. בוחרים את המאגר:
חשוב למלא את כל הקטעים של תבנית הבעיות, גם את אלה שלא מפורטים כאן.
תודה שהתעניינת בדיווח על באג, וכתיבה נעימה על הבעיה!
מה השלב הבא?
- דוח איתור הבאגים מתויג באופן אוטומטי לצורך מיון.
- אחד מחברי הצוות שיטפל ב-Blockly יבחן את הנושא ואולי ישאל שאלות להבהרה. הם גם יוסיפו תוויות, שבהן אנחנו משתמשים כדי לשמור על הסדר של הבאגים.
- יכול להיות שהבעיה תסומן בתווית 'עזרה משלימה', ובמקרה כזה תוכלו לתבוע עליה בעלות ולהתחיל לעבוד.
- יכול להיות שהבעיה תוקצה לחבר בצוותBlockly כדי לתקן את הבעיה.
- יכול להיות שהבעיה תסומן לציון דרך רבעוני כדי לציין מתי היא תתבצע.
- יכול להיות שהבעיה תיפתר בציון הדרך Icebox, כלומר אנחנו לא מתכוונים לעבוד על פתרון בעתיד הקרוב.
- זה עשוי לקרות עקב בעיות בתדירות נמוכה או באגים עם פתרונות עקיפים ידועים.
- עדיין אפשר לטפל בבעיות שקשורות ל-Icebox.
- יכול להיות שהבעיה תופיע ברשימת השלבים של Bug Bash Backlog, כלומר היא לא דחופה אבל אנחנו עדיין רוצים לפתור אותה.
- בסוף כל רבעון הצוות מקדיש כמה שבועות לעבודה על באגים שנשלפו מציון הדרך של Bug Bash Backlog.
- אם צריך, יכול להיות שהבעיה תועבר מ-Blockly Core ל-blockly-samples (או בכיוון ההפוך).
- יכול להיות שהבעיה נסגרה.
בקשה לתכונה
יש משהו שברצונך לשנות כדי לשפר אתBlockly? יש לכם רעיון לפלאגין, לדוגמה או Codelab? אולי כבר יש סרטון שאתם אוהבים, ומצאתם דרך לשפר אותו. אם כן, הגעתם למקום הנכון! ריכזנו כאן כמה שלבים שיעזרו לכם ליצור בקשה מעולה להוספת תכונה עם תגובה.
בדיקת הדרישות
נשמח לאפשר לכל רעיון להיכנס למאגר הזה! אבל לצערנו אנחנו רק בני אדם, ולכן יש לנו כמה הנחיות לגבי סוגי הבקשות שנקבל.
לפניכם ההנחיות לכל אחד מקטגוריות הפרויקטים השונות:
- Blockly Core
- יישומי פלאגין
- דוגמאות: להציג איך משתמשים רק באחת או בשתי תכונות של חסימה.
- Codelabs: הראו כיצד להשלים משימה יחידה או ליישם התנהגות יחידה.
אבל אלו לא כללים מהירים. הן רק נועדו לתת לכם מושג לגבי מה שאנחנו מחפשים לפני שתקדישו זמן לבניית הבקשה שלכם להוספת תכונה.
אם לא בטוחים אם משהו מתאים, נסו לפרסם אותו בפורומים שלנו למפתחים. וזכרו, גם אם הרעיון שלכם לא יתקבל, נשמח אם תבנו אותו כפלאגין או כמדריך של צד שלישי!
אסוף את המחשבות שלך
לא צריך ללטש את הרעיון שלך במלואו עם קישוטים ודיאגרמות לפני שממשיכים לשלוח, אבל צריך לדעת בדיוק מה אתם מחפשים. הנה כמה שאלות שכדאי לחשוב עליהן לפני שמתחילים לכתוב:
- למה אני רוצה את התכונה הזו?
- האם התכונה הזו פותרת בעיה?
- מי קהל היעד של התכונה הזו?
- למה התכונה הזו משרתת אותם?
- מהן האפשרויות החלופיות שיכולות להגיע לאותה מטרה?
ברגע שתבינו את הדברים האלה, תוכלו להמשיך לשלוח בקשה להוספת תכונה טובה!
כתוב את בקשת התכונה שלך!
עכשיו אתם מוכנים לכתוב את הבקשה שלכם להוספת תכונה. בוחרים את המאגר:
חשוב למלא את כל הקטעים של תבנית הבעיות, גם את אלה שלא מפורטים כאן.
תודה שהתעניינתם בשליחת בקשה לתכונה, ושמחתם לכתוב על הבעיה!
מה השלב הבא?
- בקשת התכונה שלכם מתויגת באופן אוטומטי לצורך מיון.
- אחד מחברי הצוות שיטפל ב-Blockly יבחן את הנושא ואולי ישאל שאלות להבהרה. הם גם יוסיפו תוויות, שבהן אנחנו משתמשים כדי לשמור על הסדר של הבאגים.
- ייתכן שהתכונה תסומן כ-"Help Needed", ובמקרה כזה תוכלו להצהיר בעלות עליה ולהתחיל לעבוד עליה.
- יכול להיות שהתכונה תוקצה להטמעה אצל חבר בצוותBlockly.
- יכול להיות שהבקשה תועבר מ-Blockly Core ל-blockly-samples (או בכיוון ההפוך), במקרה הצורך.
- יכול להיות שהבקשה תיסגר, ובמקרה כזה עדיין תהיה לכם אפשרות להטמיע אותה כפלאגין של צד שלישי.