CONTRIBUTING.md

🤝 תרומה לפרויקט IsraelGPT (Contributing Guide)

תודה על התעניינותך בתרומה לפרויקט IsraelGPT! כל עזרה, בין אם בדיווח על באגים, הצעת פיצ'רים או כתיבת קוד, מוערכת מאוד.

📜 קוד התנהגות (Code of Conduct)

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

🐞 דיווח על באגים (Reporting Bugs)

אם נתקלת בבעיה או באג באפליקציה, נשמח אם תפתח/י Issue חדש במאגר ה-GitHub.

בעת פתיחת ה-Issue, אנא כלול/י כמה שיותר פרטים:

1. תיאור ברור ותמציתי: מהו הבאג?
2. שלבים לשחזור: ציין/י בפירוט את הצעדים הדרושים כדי לשחזר את הבעיה.
3. התנהגות מצופה: מה ציפית שיקרה?
4. התנהגות בפועל: מה קרה בפועל?
5. צילומי מסך: אם רלוונטי, צרף/י צילומי מסך להמחשת הבעיה.
6. סביבת עבודה: דפדפן, מערכת הפעלה וכו'.

✨ הצעת שיפורים ופיצ'רים (Suggesting Enhancements)

יש לך רעיון לפיצ'ר חדש או שיפור קיים? מצוין! גם כאן, הדרך הטובה ביותר היא לפתוח Issue חדש.

בהצעה שלך, נסה/י לענות על השאלות הבאות:

1. מה הבעיה שהפיצ'ר המוצע בא לפתור? (למשל, "קשה לי למצוא שיחות ישנות...")
2. מהו הפתרון המוצע? (למשל, "הוספת שורת חיפוש...")
3. האם יש פתרונות אלטרנטיביים?

💻 תרומת קוד (Contributing Code)

אם ברצונך לתרום קוד, התהליך הוא סטנדרטי:

1. Fork את המאגר (Repository) לחשבון ה-GitHub שלך.
2. Clone את ה-Fork למחשב המקומי שלך:

   git clone https://github.com/YOUR_USERNAME/israel-gpt.git

3. צור Branch חדש עבור הפיצ'ר או התיקון שלך. בחר שם משמעותי (למשל, feature/add-quiz-mode או fix/sidebar-bug):

   git checkout -b feature/my-new-feature

4. בצע את השינויים בקוד. הקפד/הקפידי על סגנון הקוד הקיים בפרויקט.
5. לפני שליחה, ודא/י שהקוד עובר את בדיקות ה-Lint ללא שגיאות:

   npm run lint

6. בצע Commit לשינויים שלך עם הודעה ברורה ותמציתית.

   git commit -m "feat: Add quiz mode functionality"

7. Push את ה-Branch ל-Fork שלך:

   git push origin feature/my-new-feature

8. פתח Pull Request (PR) מה-Branch שלך אל ה-Branch הראשי (main) של המאגר המקורי.
9. בתיאור ה-PR, הסבר/הסבירי את השינויים שביצעת ואת מטרתם.

תודה רבה על תרומתך! 🙏