כיצד לדווח על בעיה טובה

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

לפני הדיווח

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

2. בדקו את מדריכי פתרון הבעיות. חלק פתרון הבעיות מכסה את רוב הבעיות הנפוצות.

3. בדקו בעיות ידועות. דף בעיות ידועות מפרט בעיות שאנחנו כבר מודעים להן.

4. נסו את הגרסה האחרונה. אם אתם לא על הגרסה האחרונה, עדכנו קודם:

   triggerfish update

מה לכלול

1. סביבה

גרסת Triggerfish: (הריצו `triggerfish version`)
מערכת הפעלה: (למשל macOS 15.2, Ubuntu 24.04, Windows 11, Docker)
ארכיטקטורה: (x64 או arm64)
שיטת התקנה: (מתקין בינארי, מקוד מקור, Docker)

2. צעדים לשחזור

כתבו את רצף הפעולות המדויק שמוביל לבעיה. היו ספציפיים:

רע:

הבוט הפסיק לעבוד.

טוב:

1. הפעלתי Triggerfish עם ערוץ Telegram מוגדר
2. שלחתי את ההודעה "בדוק את היומן שלי למחר" בהודעה ישירה לבוט
3. הבוט הגיב עם תוצאות היומן
4. שלחתי "עכשיו שלח את התוצאות האלה באימייל ל-alice@example.com"
5. צפוי: הבוט שולח את האימייל
6. בפועל: הבוט מגיב עם "Write-down blocked: CONFIDENTIAL cannot flow to INTERNAL"

3. התנהגות צפויה מול בפועל

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

4. פלט לוג

צרפו חבילת לוג:

triggerfish logs bundle

אם הבעיה רגישה מבחינת אבטחה, ניתן לצנזר חלקים, אבל ציינו ב-issue מה צנזרתם.

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

5. תצורה (מצונזרת)

הדביקו את החלק הרלוונטי של triggerfish.yaml שלכם. תמיד צנזרו סודות. החליפו ערכים ממשיים בממלאי מקום:

# טוב - סודות מצונזרים
models:
  primary:
    provider: anthropic
    model: claude-sonnet-4-20250514
  providers:
    anthropic:
      model: claude-sonnet-4-20250514
      apiKey: "secret:provider:anthropic:apiKey"  # מאוחסן ב-keychain
channels:
  telegram:
    ownerId: "REDACTED"
    classification: INTERNAL

6. פלט Patrol

triggerfish patrol

הדביקו את הפלט. זה נותן לנו תמונת מצב מהירה של בריאות המערכת.

סוגי בעיות

דיווח באג

השתמשו בתבנית זו לדברים שבורים:

## Bug Report

**סביבה:**
- גרסה:
- מערכת הפעלה:
- שיטת התקנה:

**צעדים לשחזור:**
1.
2.
3.

**התנהגות צפויה:**

**התנהגות בפועל:**

**הודעת שגיאה (אם יש):**

**פלט Patrol:**

**תצורה רלוונטית (מצונזרת):**

**חבילת לוג:** (צרפו קובץ)

בקשת תכונה

## Feature Request

**בעיה:** מה אתם מנסים לעשות שאתם לא יכולים היום?

**פתרון מוצע:** כיצד לדעתכם זה צריך לעבוד?

**חלופות שנשקלו:** מה עוד ניסיתם?

שאלה / בקשת תמיכה

אם אתם לא בטוחים אם משהו הוא באג או שאתם פשוט תקועים, השתמשו ב-GitHub Discussions במקום Issues. דיונים טובים יותר לשאלות שאולי אין להן תשובה אחת נכונה.

מה לא לכלול

• מפתחות API או סיסמאות גולמיים. תמיד צנזרו.
• נתונים אישיים מהשיחות. צנזרו שמות, כתובות אימייל, מספרי טלפון.
• קבצי לוג שלמים inline. צרפו את חבילת הלוג כקובץ במקום להדביק אלפי שורות.

לאחר הדיווח

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