|
מנהל התקלים/נושאים לטיפול בגרמפס נמצא בכתובת הבאה: |
מנהל התקלים/הנושאים מאפשר למשתמשים ולמפתחים לדווח על נושאים חדשים ולעקוב אחר התקדמות הטיפול בהם. מומלץ להקדיש מעט זמן לקריאת ההנחיות למנהל הסוגיות להלן, ולעיין באיך ליצור דוח טקל טוב. בנוסף, כדאי לעיין גם בסוגיות ידועות ובסוגיות נפוצות.
המלצות
בעת ניסוח דוח תקל (באג) בגרמפס:
- נדרש לדייק בניסוח הסוגיה
- להקפיד על נוסח ברור: להסביר כיצד ניתן לשחזר את הבעיה, צעד אחר צעד, כדי שאחרים יוכלו לשחזר את התקל או להבין את הבקשה.
- יש לכלול סוגיה אחת בלבד בכל דוח
- יש לכלול בדוח קישורים וצילומי מסך רלוונטיים ודוגמאות ככל שניתן
|
|
לפני יצירת דוח "תקל"... ניסוח דוח תקל כרוך לרוב בעבודת מחקר ומאמץ כתיבה מרובים. כדי לחסוך עבודה מיותרת:
|
דיווח על תקל
1. התחברות
כדי שניתן יהיה לדווח על תקל או להעלות בקשת שינויים, שיפורים ותוספות תוכנה, נדרש תחילה לייצור חשבון כניסה למערכת מעקב התקלים של גרמפס:
- אל מערכת המעקב התקלים ניתן להגיע דרך הקישור: https://gramps-project.org/bugs/login_page.php ולהקיש על לחצן login כדי להתחבר לחשבון קיים. או ;
- לבחור ב־Signup for a new account, או לבקר באתר שבקישור הבא כדי ליצור חשבון כניסה חדש: https://gramps-project.org/bugs/signup_page.php. לאחר יצירת חשבון משתמש חדש. בשל פעילות מוגברת של רובוטי־ספאם, בקשות לפתיחת חשבון חדש עשויות לדרוש אישור מוקדם של משתמש. יש לקחת בחשבון שעשויות לחלוף עד 12 שעות לפני שתשלח הודעת דוא"ל עם קישור לחשבון. רק לאחר לחיצה על הקישור שהתקבל בדוא"ל החוזר, ניתן יהיה להכנס לחשבון ולדווח על תקלים. כתובת הדוא"ל ששימשה ליצירת החשבון תשאר חסויה.
|
מערכת ניהול התקלים של גרמפב נשענת על תוכנת Mantis. זוהי מערכת צד ג' שמיזם גרמפס עושה בה שימוש לניהול ומעקב תקלים. וכאמור חוסר שלמות. ממשק המערכת תורגם לשפה העברית באופן חלקי ביותר ובאיכות ירודה, התרגום לוקה בחוסר אחידות במושגים, בשפה לא תקנית
כדי להמנע מחוסר נוחות זה ניתן להשתמש בשפה האנגלית. |
כיצד לשנות את תמונת הפרופיל ב־MantisBT
מערכת MantisBT (מנהל התקלים בקוד פתוח שמיזם גרמפס משתמש בו) משתמשת באופן אוטומטי בשירות Gravatar בהתאם לכתובת הדוא״ל הרשומה.
2. חיפוש בוויקי ובדיווחי באגים קיימים
לעיתים ההתנהגויות של תוכנת גרמפס שנצפית על המקע עשויות להיראות מוזר, אך לא מן הנמנע שזו התנהגות תקינה לחלוטין ועל־לפי־התכנון. לכן לפני דווח על תקל, הצעד הראשון הוא לחפש בוויקי של גרמפס כדי לראות מהי ההתנהגות שמתועדת. אם לא נמצא הסבר לתופעה ועדיין אין ודאות לגביה, ניתן לשאול בקהילת גרמפס ב־Discourse.
אם עדיין נראה שמדובר בבאג, לפני פתיחת דווח חדש על תקל, כדאי מאוד ואף נדרש לחפש במערכת מעקב תקלים קיום תקל זהה או דומה, ייתכן שתקל כזה או דומה כבר דווח בעבר. כדי לבדוק זאת, יש ללחוץ על הצגת תקלים. החלק העליון של העמוד שמור למסננים, שניתן להגדיר. לרוב מסנני ברירת־המחדל מתאימים. מתחת למסננים יש תיבת חיפוש. יש להזין את המונחים שמתארים בצורה הטובה ביותר את התקל, וללחוץ על החלת מסנן כדי לחפש. אם יש הודעת שגיאה, כדאי לנסות להדביק חלק ממנה, כדי לבדוק אם היא כבר דווחה.
אם התקל כבר דווח, יש לקרוא את דיווח התקל ולבדוק אם ניתן להוסיף מידע. אם כן, ניתן להשאיר הערה עם מידע נוסף שיסייע למפתחים.
3. יצירת דווח תקל חדש
ליצרית דוח חדש יש להקיש על אחד מלחצניי Report Issue ולהזין בטופס שיפתח את המידע שנדרש, להלן יוסבר כיצד לבחור את המייזם שאליו שייך התקל. יש לתאר ולהסביר באופן מילולי, בפשטות ובהירות את הסוגיה, המפתחים ממש 'רעים' בקריאת מחשבות. צוות הפתוח יסגור ללא רחם את התקלים בהם אין מידע מספק משמעותי כלל, כגון 7126#. חשוב לא לשכח להזין את גרסת גרמפס בה נתגלה התקל. ניתן לבדוק זאת בקלות מסרגל הקלים בגרמפס, עזרה, אודות.
כיצד להמשיך
השלב הראשון בהגשת סוגיה במערכת המעקב הוא לקבוע לאיזה מיזם יש לשייך אותה. מתיבת Select Project יש לבחור את המיזם המתאים, ובאמצעות הרשימה הנפתחת Choose Project לבחור את ה״מיזם״ עבור התקל או בקשת התכונה. ״מיזמים״ משמשים לסיווג סוגיות. במערכת המעקב קיימים שני סוגי מיזמים: Feature Requests ו־Gramps.
- מיזם Feature Requests משמש לתיעוד בקשות לתכונות חדשות.
- אם הסוגיה מייצגת פונקציונליות שאינה קיימת כיום בגרמפס, יש להגיש את הסוגיה במסגרת מיזם Feature Requests.
- מיזם Gramps משמש לתיעוד כל הסוגיות שקשורות לגרמפס.
- אם הסוגיה מייצגת בעיה בפונקציונליות ששוחררה במהדורה יציבה, או בעיה בפונקציונליות שקיימת רק בענף הראשי (master), יש להגיש את הסוגיה במסגרת מיזם Gramps.
- לדיווחי תקל ולבקשות תכונה שקשורים ל״מרשתת גרמפס״, ניתן לעיין ב־| Get Help - Gramps Web
הזנת פרטי סוגיה
עמוד Enter Issue Details הוא המקום לשיתוף המפתחים בפרטי הסוגיה או בבקשת התכונה.
דוח סוגיה/תקל מונגש למשתמשים בצורת טופס עם שדות למילוי. מקצת מהשדות הם שדות חובה שמסומנים בכוכבית אדומה ליד שם השדה. בסוגיה חלק מהשדות הם שדות בחירה, כלומר מאפשרים בחירת ערכים מתוך רשימת ערכים, שדות אחרים הם שדות מלל חופשי בהם ניתן להזין מלל לפי העניין. בשדות מסוימים ניתן גם להוסיף צרופות כגון קבצים וצילומי מסך. יש להשלים ככל האפשר את כל הסעיפים הרלוונטיים בטופס, ולהיות ערוכים לענות על שאלות הבהרה במשך ככל שהדיווח דורש הבהרה. להלן מדריך תמציתי: כיצד ליצור דוח תקל טוב לגרמפס, שיגדיל מאוד את הסיכוי לשחזור הסוגיה על ידי מפתחים ולכן גם לתיקונה.
מילוי הטופס
- בחירת קטגוריה
שדה חובה, בחירת ערך מתוך רשימת ערכים שנועדו לסווג בעיות וסוגיות לפי נושאים שונים.
- ניתן לשחזור
שדה בחירה מתוך רשימת ערכים שמסווגים את הסוגיה על פי אפשרות לשחזר אותה.
- בחירת פרופיל
- גרמפס פועל על כמה מערכות הפעלה, ולכן חשוב לציין על איזו מערכת הפעלה ומהדורה מדובר בדיווח. כאן נמסר מידע זה. MantisBT מאפשר לאחסן כמה פרופילים בחשבון, כך שניתן לבחור את הפרופיל המתאים — דבר שימושי אם גרמפס מופעל בתצורות מערכת שונות.
- מהדורת מוצר
- המיזמים ששמותיהם נראים כמו Gramps x.x.X הם המקום לדיווח על סוגיות ששייכות באופן ייעודי לענף תחזוקה (ief_introduction_to_Git#Types_of_branches|סוגי ענפים]]). קיים מיזם נפרד לכל ענף תחזוקה.
- לתיעוד סוגיות ששייכות רק לענף הראשי בGit (סוגי ענפים), יש להשתמש במהדורה הבאה שטרם שוחררה, לדוגמה: 6.1.0, כפי שמוצג בהדרכים של MantisBT.
- מהדורת תוסף
- אם מדווחים על תקל בתוסף צד־שלישי, ניתן להשתמש במנהל התוספים או במנהל התקעים (ואפשר גם במנהל התקעים המשופר – תוסף) כדי לאתר את מהדורת התוסף ולכלול אותה בדיווח.
קודי תחביר שימושיים במערכת מעקב התקלים MantisBT
להלן קודי תחביר שימושיים של מערכת מעקב התקלות MantisBT שניתן להשתמש בהם:
- שימוש ב־
#לפני מספר תקלה יוצר קישור לתקלה. לדוגמה:#1הופך ל־1 - שימוש ב־
@לפני שם משתמש נועד לאזכור אדם (הערה: שמות משתמש עם רווחים משובצים אינם נתמכים) - שימוש ב־
~לפני מספר תגובה יוצר קישור לתגובה, בדומה ל־:{url}#c{comment number}. לדוגמה:~3הופך ל־[1] - כדי לקשר בקשת משיכה (Pull Request) מ־GitHub במערכת מעקב התקלות, יש להשתמש ב־
p:gramps:nnnn:כאשרnnnnהוא מספר ה־PR. (תקף רק למאגר הראשי של גרמפס, ולא לתוספים.) - כדי לקשר בקשת משיכה (Pull Request) מ־GitHub במערכת מעקב התקלות, עבור gramps addons-source יש להדביק את קישור ה־GitHub המלא.
תגי HTML מוגבלים
- ניתן להשתמש בשדה המלל בערכה מוגבלת של תגי HTML:
<p> </p>להגדרת פסקה.<li>להגדרת פריט רשימה בשימוש עם:<ul>רשימות לא־ממוינות<ol>רשימות ממוינות
<br>להוספת שבירת שורה יחידה.<pre> </pre>להוספת מלל מעוצב מראש, שמוצג בגופן ברוחב קבוע, ושומר על רווחים ושבירות שורה.<i> </i>לרוב מציג מלל ב־נטוי.<b> </b>מציג מלל מודגש<u> </u>להוספת קו תחתון למילה שנאייתה שגויה<em> </em>מעבד מלל כמלל מודגש־משמעות (emphasized).<strong>מגדיר מלל חשוב.
פתרון תקלים (עבור מפתחים)
מידע וההנחיות להלן נועדו למפתחים שעוקבים אחר הסוגיות שדווחו.
עמוד מפת הדרכים של 'מעקב התקלים' מפרט את התקלים המתועדפים כעת לשחרורים הבאים. אם אתם מחפשים תקל לתיקון, הגעתם למקום הנכון להתחיל בו. המיקום במפת הדרכים נשלט על ידי השדה "גרסת יעד" עבור התקל. בגרסאות הדמה המיוחדות אלו שמסתיימות בספרות 99 ("X.Y.99"), כמו "3.4.99" ו- "4.0.99", מופיעים תקלים שבסופו של דבר נרצה לתקן עבור גרסת "X.Y", אך עדיין לא ממש יודעים את אבן הדרך אליה שובץ התקל כתאריך יעד. תקלים שעלולים לעכב שחרור גרסה אמורים להיכלל במפת הדרכים עם מספר גרסה אמיתי, בכל אופן אין להעביר אותם לפני שניתן הסבר מספק למניע או או התראה [ברשימת הדיוור (רשימת devel) http://sourceforge.net/mailarchive/message.php?msg_id=31870820]. אם תקנתם תקל שתוכנן במקור לאבן דרך במועד מאוחר יותר לפני שיצא אחד קודם, נא להתאים ידנית את שדה שחרור היעד, לפני סימון התקל כפתור, אחרת מצג מפת הדרכים לא היה מדויק [2].
באופן כללי, לאחר פתרון סוגיה, כדאי תמיד להוסיף הערה עם סימן # מקדים למספר הקיבוע שתיקן את הבעיה.
כאשר מיישבים סוגיות בענף תחזוקה, תמיד צריך להגדיר בשדה "תוקן בגרסה" את מספר גירסת השחרור הבאה שיופק מאותו ענף. נועד על מנת שהנושא יופיע כראוי בעמוד יומן השינויים (ChangeLog) של אותו פרויקט (https://gramps-project.org/bugs/changelog_page.php).
אין לסמן תקלים בפרויקטי ענף תחזוקה כסגורים עד שהמפתח קיבע את השינוי לענף התחזוקה המתאים. בנוסף, באחריות המפתחים לוודא שהשינוי מוזג לענף הראשי.
למידע נוסף
- כיצד ליצור דוח תקלים טוב
- סוגיות ידועות
- סוגיות שכיחות
- סיוע במייזם גרמפס סיווג ובירור תקלות
ב־MantisBT.org יש דיווחים שכוללים תיעוד שמיועד למשתמשים (לא למנהלים):
- 0005070: נכתב תיעוד התחלה מהירה ל־[MantisBT] [.doc, .pdf, .swx] במקרה שיש עניין
- 0008939: דגם מחזור־חיים [Visio] לדיווח ב־MantisBT