He:מעקב תקלים
גרמפס מנהל מעקב אחר תקלים ובקשות לתוספות ושיפורי תכנה באמצעות מערכת מנטיס. מנטיס (Mantis Bug Tracker) הוא מערכת חינמית, כתובה בקוד פתוח, שנועדה לאפשר ניהול ומעקב תקלים מקוון ושיתופי.
השימוש הנפוץ ביותר במנטיס הוא אכן מעקב אחר ליקויי תכנה. עם זאת, מנטיס משמש לעיתים קרובות כמערכת מעקב אחר בעיות כלליות וככלי לניהול פרויקטים.
את אתר מעקב אחר סוגיות/תקלים בגרמפס ניתן למצוא בכתובת הבאה: https://www.gramps-project.org/bugs
מערכת מעקב אחר סוגיות/תקלים זו מאפשרת למשתמשים ומפתחים לדווח על סוגיות חדשות ולעקוב אחר מהלך התקדמותן.
נא הקדישו מספר דקות לעיון בהוראות המעקב אחר סוגיות מטה ולקרוא גם את כיצד ליצור דוח תקלים טוב. כמו כן, לעיין ב סוגיות ידועות וב- סוגיות נפוצות.
Contents
המלצות
- היו מדוייקים
- היו ברורים: הסבירו בבהירות כיצד ניתן לשחזר את התקלה, צעד אחר צעד, כך שאחרים יוכלו לשחזר אותה גם, או להבין את הבקשה.
- נא לא לכלול יותר מסוגיה אחת בכל דיווח.
- צרפו דוגמאות ו/או קישורים הנוגעים לסוגייה.
דיווח על תקלה
1. התחברות
על מנת לדווח על תקל או להעלות בקשת שינויים ותוספות תכנה, נדרש תחילה לייצור חשבון כניסה למעקב התקלים של גרמפס:
- הקישו עלlogin כדי להתחבר לחשבון באתר https://gramps-project.org/bugs/login_page.php או;
- בחרו ב- Signup for a new account, או בקרו באתר ש בקישור הבא כדי ליצור חשבון כניסה חדש: https://gramps-project.org/bugs/signup_page.php. בעת יצירת חשבון משתמש חדש, נא לקחת בחשבון שעשויות לחלוף עד 12 שעות לפני שתשלח הודעת דוא"ל עם קישור לחשבון. רק לאחר לחיצה על הקישור שהתקבל בדוא"ל החוזר, ניתן יהיה להכנס לחשבון ולדווח על תקלים. כתובת הדוא"ל שלכם תטופל בסודיות.
2. חיפוש תקלים קיימים
יתכן מאוד שתקל זהה או דומה דווח כבר בעבר על ידי משתמשים אחרים. כדי לבדוק זאת, נא להקיש על View Issues. החלק העליון של העמוד שמור למסננים אותם ניתן להגדיר לחיפושים עתידיים, אך לרוב מסנני ברירת המחדל שברשימה, יספקו מענה טוב. בתיבה Search שמתחת למסננים אלה, יש להזין את המונחים המתארים בצורה הטובה ביותר את התקל אותו מחפשים, ואז הקשה על Apply Filter כדי להחיל את המסנן ולחפש. במידה ומתקבלת הודעת שגיאה, הדביקו חלק מהודעת השגיאה בתיבת החיפוש כדי ללבדוק אם היא כבר דווחה. אם התקל דווח כבר בעבר, נא לקרוא את דוח התקל הקיים ולבדוק אם הוא מכיל מידע נוסף שעשי לסייע בפתרון הבעיה. במידה ומידע כזה אכן קיים, כדי להשאיר הודעה עם המידע הנוסף שיעזור למפתחים לעזור לכולנו.
3. דווח על תקל חדש
הקשה על אחד מלחצני Report Issue והזנו את המידע הנדרש, ראו להלן כיצד לבחור את הפרויקט שאליו שייך התקל. היו מילוליים והסבירו בפשטות ובהירות את הסוגיה, המפתחים 'רעים' בקריאת מחשבות. צוות הפתוח יסגור ללא רחם את התקלים בהם אין מידע משמעותי כלל, כגון 7126#. חשוב לא לשכח להזין את גרסת גרמפס בה אתם משתמשים. ניתן לבדוק זאת בקלות מסרגל הקלים בגרמפס, עזרה, אודות.
כיצד להמשיך
השלב הראשון בדיווח סוגיה הוא לקבוע לאיזה פרויקט לשייך אותה. מתיבת הגלילה בחירת פרויקט, יש לבחור את ה"פרויקט" עבור התקלה. השימוש ב"פרויקטים" נועד לסווג נושאים. ישנם שני סוגים של פרויקטים באתר מעקב התקלים, בקשות לתוספות ושינויים וגראמפס:
- פרויקט בקשות לתוספות ושינויים משמש כמאגר להזנת ותיעוד בקשות לתכונות חדשות.
- אם הסוגיה מייצגת יכולות שאינן קיימות כיום בגרמפס, יש לסווג את הסוגיה במסגרת פרויקט בקשות לתוספות ושינויים.
- פרויקט גרמפס משמש כמאגר להזנת ותיעוד סוגיות קיימות בגרמפס.
- אם הסוגיה מייצגת בעיית פונקציונליות ששוחררה במהדורת קוד יציבה, יש לדווח על הבעיה במסגרת הפרויקט המתאים לענף התחזוקה עבור אותו שחרור. לדוגמה, יש לדווח על תקל שנמצא ב- גרמפס 5.1.0 בפרויקט גרמפס 5.1.0 .
- אם הסוגיה מייצגת בעיית פונקציונליות שקיימת רק בענף הראשי (master), או שהבעיה קיימת בענף הראשי, אך לא בשחרורים יציבים כלשהם, יש לדווח על הבעיה במסגרת הפרויקט Gramps Master'.
הזנת פרטי הסוגייה
העמוד Enter Issue Details הוא המקום לשתף עם צוות הפתוח סוגיות או בקשת לתוספות ושיפורים בתכנה.
נא לנסות ולהשלים את כל הסעיפים הרלוונטיים ככל שניתן ולהיות מוכנים לענות על שאלות בהמשך במידה ונדרש בירור או הבהרה לסוגיה, המאמר בעמוד כיצד ליצור דוח תקלים טוב.
מילוי הטופס
- גרסת המוצר
- הפרויקטים עם שמות כמו גרמפס x.x.X הם המקום לדווח בו על סוגיות החלות במיוחד על ענף תחזוקה (ראו סוגי ענפים). לכל ענף תחזוקה קיים סוג פרויקט נפרד.
- פרויקט Gramps Master אמור לשמש רק מפתחים ובודקי תכנה לקוד שנכתב לאחרונה. זהו המקום לתיעוד נושאים החלים רק על ענף המאסטר בגיט (ראו סוגי ענפים). למעשה קיים רק פרויקט "מאסטר גרמפס" אחד מאחר ובמאגר יכול להימצא רק ענף מאסטר אחד.
קודי תחביר שימושיים למעקב אחר תקלים במנטיס
להלן מספר דוגמאות תחביר קוד בהם ניתן לשימוש במעקב סוגיות מנטיס:
- שימוש ב-
#
לפני מספר התקל יגרום לכתיבת קישור לתקל. לדוגמה:#1
הופך ל 1 - שימוש ב-
@
לפני שם משתמש יאזכר את אותו משתמש (הערה: אין תמיכה בשמות משתמש המכילים רווחים) - שימוש ב-
~
לפני מספר הערה יגרום לכתיבת קישור להערה, זהה ל- :{url}#c{comment number}
. לדוגמה:~3
הופך ל- [1]
תגי HTML מוגבלים
- ניתן להשתמש בשדות המלל בערכה מוגבלת של תגי HTML:
<p> </p>
להגדרת פסקה.<li>
להגדרת רשימת פריטים יחד עם:<ul>
רשימול לא ממוינות.<ol>
רשימות ממוינות.
<br>
להכנסת 'שורה בודדת' יחידה.<pre> </pre>
להוספת מלל מעוצב מראש, המוצג בגופן ברוחב קבוע, ושמירה על רווח וגם על מעברי שורות.<i> </i>
הצגת מלל נטוי.<b> </b>
הצגת מלל מודגש.<u> </u>
הדגשת שגיאות איות בקו תחתון.<em> </em>
מלל מודגש.<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).
אין לסמן תקלים בפרויקטי ענף תחזוקה כסגורים עד שהמפתח קיבע את השינוי לענף התחזוקה המתאים. בנוסף, באחריות המפתחים לוודא שהשינוי מוזג לענף הראשי.
ראו גם
- כיצד ליצור דוח תקלים טוב
- סוגיות ידועות
- סוגיות שכיחות
- סייעו לפרוייקט גרמפס Bug triage.