תרומת קוד לפרוייקט אוצריא

תרומת קוד

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

להלן יפורטו שלבי העבודה כדי שתוכלו גם אתם לתרום קוד בקלות:

יצירת עותק משלכם

• ראשית יש לפתוח חשבון בגיטהאב, אם לא עשיתם זאת עדיין.
• לאחר מכן יש לגשת לפרוייקט אוצריא וללחוץ על הכפתור fork. זה ייצור מזלג של הפרוייקט בחשבון שלכם.
• על המחשב שלכם יש לוודא שמותקנת תוכנת git להורדה. ניתן גם להתקין תוכנת gitHub Desktop או להשתמש בעורך הקוד VSCODE לשימוש נוח יותר בגיט.
• יש לשכפל את העותק שלכם אל המחשב המקומי באמצעות פקודת git clone https://github.com/userName/otzaria.git כאשר כמובן userName הוא שם המשתמש שלכם.

התקנת Flutter

• יש להתקין את Visual Studio 2022 עם כל הכלים הנדרשים לבניית תוכניות C++.
• יש להתקין RUST. ניתן להוריד מכאן
• יש להתקין את פלטפורמת פלאטר, לפי ההוראות באתר הרשמי.

בנייה מקוד מקור

• כעת נבדוק שאכן הכל תקין. נריץ את הקוד באמצעות הפקודה flutter -d run או F5 בעורך הקוד.

בחירת נושא לטיפול

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

יצירת branch

• ניצור ענף חדש בגיט: git checkout -b feature/your-feature-name
• טיפ: ניתן להתקין את התוסף הזה לVSCode ושם ניתן בקלות ליצור ענף עבור הנושא הרצוי.

עריכת הקוד

• כעת נכניס את השינויים שנרצה.
• ניתן להיעזר בכלי בינה מלאכותית, המומלצים: cursor או Cline
• כמובן שנריץ את הקוד אצלנו ונראה שהכל תקין והנושא נפתר.

דחיפת השינויים

• כעת נדחוף את השינויים לגיטהאב:

git add .
git commit -m "תיאור מפורט של השינויים"
git push origin feature/your-feature-name

פתיחת PR

• בדף הריפו שלנו ב-GitHub, נלחץ על "Compare & pull request"
• טיפ: אפשר להשתמש לחלופין בתוסף הזה
• נפרט את השינויים שנעשו. יש לעשות זאת על פי הכללים המפורטים כאן: Conventional Commits specification.
• מתחזקי הפרוייקט יעברו על הקוד שלכם, יבדקו אותו, ואם הכל תקין הם ימזגו את הPR לענף הראשי.

למידע נוסף

פרטים נוספים אודות פלטפורמת Flutter ושפת Dart אפשר למצוא כאן.

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