הנחיות אלו מסבירות כיצד לכתוב דיווח באג או בקשת תכונה טובה בתוכנת המעקב על באגים של ויקימדיה (ראו Phabricator למידע נוסף). דיווחי באגים אפקטיביים הם אלו שיש להם את הסיכוי הטוב ביותר שיתוקנו. דיווחים על באגים נדרשים להיכתב באנגלית. אם אינכם יכולים לכתוב באנגלית, נסו להשתמש בכלי לתרגום מכונה, כגון Google Translate.

המלצות מהירות לדיווחים

• היו מדויקים
• היו ברורים: הסבירו כיצד לשחזר את הבעיה, צעד אחרי צעד, כדי שאחרים יוכלו לשחזר את הבאג
• יש להכליל רק בעיה אחת בכל דיווח
• היו ברורים: הסבירו 1) איך לשחזר את המצב, צעד אחר צעד, מבלי להשאיר מקום לפרשנות, 2) התנהגות צפויה, 3) התנהגות בפועל. בסעיפים נפרדים
• כללו רק באג ספציפי אחד או בקשת תכונה ספציפית אחת לכל משימה
• כללו קישורים ודוגמאות רלוונטיים

לפני דיווח

דיווח על באג או בקשה ליכולת חדשה

אם נתקלתם בבאג בגרסה עדכנית ואף אחד עוד לא דיווח עליו, אז:

1. גשו phabricator.wikimedia.org.
2. תתבקשו להתחבר לחשבונכם (או ליצור אחד) אם טרם עשיתם זאת (ראו "יצירת חשבון ").
3. לחצו על כפתור הסימניות בפינה השמאלית העליונה ובחרו "דווח על באג בתוכנה" (או "דווח על בעיית אבטחה" כדי לדווח על בעיית אבטחה ).
4. מלאו לפחות את השדות הבאים:
   • כותרת (Title): משפט קצר שמסביר את הבעיה (לא הצעה לפתרון).
     • רצוי: "Selecting gender is not functional on Special:Preferences"
     • לא רצוי: "Software crashes"
   • תיאור (Description): הפרטים המלאים של הבעיה, ובהם יש לספק את כל המידע שיש לכם כרגע. אם זה לא מספיק תתבקשו לקבלת מידע נוסף יחד עם הנחיות כיצד להשיגו. שדה זה צריך לכלול:
     • לתקלות:
       • שלבים לשחזור (Steps to Reproduce): שלבים פשוטים וקלים למעקב שאפשר באמצעות לשחזר את הבעיה המתוארת. חשוב לציין הגדרות מיוחדות.

         דוגמה:

         1. Go to https://en.wikipedia.org with Internet Explorer version 10.0;
         2. Make sure you are logged in;
         3. Select "My Preferences" menu;
         4. Go to "Gender" and select female gender from box list;
         5. Click "Save" button.

       • התוצאה בפועל (Actual Results): מה קרה אחרי ביצוע הפעולות

         דוגמה:

         "There is no female gender in front of my username."

       • התוצאה הצפויה (Expected Results): מה הייתה התוכנה צריכה לעשות, אלמלא היה באג

         לדוגמה:

         "My gender is shown in front of my username."

     • עבור בקשות ליכולות חדשות:
       • תיאור של מה מטרת השינוי ותכליתו. הסבירו מה אתם מקווים שהתכונה תפתור (הבעיה הבסיסית בפועל) יחד עם דוגמאות ספציפיות; אך אל תדרשו פתרון ספציפי, שכן עשויים להיות פתרונות אחרים/טובים יותר. [סיפור משתמש https://interactions.acm.org/archive/view/november-december-2013/user-stories-dont-help-users-Introducing-persona-stories] הוא דרך יעילה להעביר זאת.

         דוגמה:

         "As a new editor, I would like to be acknowledged for my contribution to the project, so that I feel welcomed and valued"

     • ספקו כל מידע נוסף שעשוי להיות שימושי, כגון:
       • הדפדפן, הרקע (סקין) ומערכת ההפעלה שבו נתקלתם בבאג;
       • קישורים לשינויים בדף אחד או יותר שבהם נתקלתם בבאג; או
       • האם הבעיה מופיעה תמיד, לעתים, או רק בדפים מסוימים או בתנאים מסוימים.
   • על מנת לצרף קובץ יומן צילום מסך (ודאו שהם אינם מכילים מידע פרטי או רגיש), לחצו על כפתור Upload File (בצורת ענן עם חץ) בתפריט הכלים של שדה ה-Description.
   • בחרו את התגים (פרויקט(ים)) שבהם מצאתם את הבאג:
     • פרויקטים הם הדרך שבה מפתחים מוצאים משימות לעבוד עליהן. כדי לזהות את הפרויקט/ים הנכונים, השתמשו בפונקציית החיפוש (בפינה הימינית העליונה; או השמאלית אם הגדרת השפה שלכם באנגלית) כדי למצוא את התיאור שלו.
     • זה יכול להיות למשל MediaWiki-General project של תוכנת הוויקי עצמה, או Wikimedia-Site-Requests של שינויי הגדרות של אתרי ויקי של ויקימדיה (ראו "Selecting projects ").
   • עותקים (CC): אם אתם יודעים על משתמשים מסוימים שיתעניינו בקבלת עדכונים על המשימה ניתן לציין אותם כאן. אחרת, התעלמו משדה זה.

ודאו שהדיווח הושלם, ולאחר מכן לחצו על כפתור יצירת דיווח ("Create Task"). הדיווח ישמר כעת במסד הנתונים. זה מאפשר למישהו שמתעניין בדוח להסתכל עליו ואפשר לעבוד עליו .

העדיפות למשימה תיקבע על ידי מפתחים אם הם מתכננים לעבוד על המשימה (ראו "קביעת דחיפות").

זהו זה! תודה לך על העזרה בפיתוח מדיה ויקי והפרויקטים של ויקימדיה!

דיווח על באג ב-JavaScript

ר' גם Help:Locating broken scripts

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

כאשר אתם נתקלים בבאג שעשוי להיות קשור לJavaScript, עשו כמיטב יכולתכם לזהות הודעות שגיאה ולהעתיק אותן לדוח הבאג.

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

אם הבעיה היא בקוד של סקריפט משתמש או גאדג'ט עצמו, ייתכן ש-Phabricator לא יהיה המקום שבו תטופל הבעיה.^[1] מישהו עלול להפנות אותכם לדף השיחה של הסקריפט (אם הבעיה מזוהה).

דיווח על בעיה בקישוריות

אם אתם מתקשים להגיע לאתר ויקימדיה בכלל (חיבור לאינטרנט איטי וכו'), אנא עקבו אחר https://wikitech-static.wikimedia.org/wiki/Reporting_a_connectivity_issue

דיווח על בעיית התחברות

אם אתם נתקלים בבעיות בכניסה לחשבון שלכם, אנא עקבו אחר Manual:How to debug/Login problems .

הערות

ר' גם

• "כיצד לדווח על באגים באופן יעיל" מאת סימון טטהם (באנגלית)
• הפבריקטור של ויקימדיה
  • נימוסי שימוש בפבריקטור
• ניהול באגים/מחזור החיים של דיווח באגים
• כתיבת דוח באג טוב או בקשת תכונה
• ויקיפדיה האנגלית: דוחות באגים ובקשות לתכונה