תרומה למאגר קוד פתוח

הושלמה

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

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

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

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

נהל את כוונתך לתחזוקתם

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

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

  

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

יצירת בקשת משיכה במאגר GitHub

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

התרומה שלך תקבל צורה של בקשת משיכה או PR. בקשת משיכה היא מקום מיוחד ב- GitHub המכיל כמה דברים:

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

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

יצירת בקשת משיכה שלב אחר שלב

1. פתח את דף GitHub של הפרוייקט שאליו ברצונך לתרום.

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

   

3. בחר מהמאגרים מהתפריט פרופיל החשבון שלך.

   

4. בחר את המזלג של המאגר.

5. בחר את קוד כדי לקבל מידע על האופן בו ניתן "לשכפל" את מאגר Git למחשב המקומי שלך.

   

6. בחר את הלוח כדי להעתיק את כתובת ה- URL של המאגר ולאחר מכן הזן במסוף:

   git clone <REPOSITORY_URL>
   

   פקודה זו תיצור עותק של המאגר במחשב המקומי שלך.

   לחלופין, באפשרותך להשתמש GitHub לשולחן אם אתה מעדיף להשתמש ביישום. לחלופין, באפשרותך ב- GitHub Codespaces אם האפשרות מוצעת לך. אם אתה משתמש בקוד Visual Studio, GitHub Codespaces ירגיש מוכר לך.

7. לאחר סיום השכפול של הפרוייקט, הזן את תיקיית הפרוייקט:

   cd <PROJECT_FOLDER>
   

8. (אופציונלי) צור הסתעפות חדשה באמצעות הפקודה הבאה:

   git checkout -b <BRANCH_NAME>
   

   שלב זה אינו הכרחי, אך מומלץ מאוד. באמצעות ענף חדש, באפשרותך לעבוד על תרומות מרובות בנפרד, שכל אחת מהן משתמשת בענף אחר.

9. בצע את השינויים הרצויים בפרוייקט ובצע אותם:

   git add .
   git commit -m "<COMMIT_MESSAGE>"
   

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

10. דחף את השינויים שלך מרחוק באמצעות הפקודה:

    git push --set-upstream origin <BRANCH_NAME>
    

    פקודה זו יוצרת הסתעפות חדשה במאגר במעלה הזרם ב- GitHub (הסתעפות שלך) דוחפת את כל הפעולות שלך אליה.

    הערה

    כאשר אנו על במעלה הזרם, אנו מתייחסים למאגר המרוחק המקושר למאגר המקומי שלך. הערך origin הוא כינוי ברירת המחדל עבור כתובת ה- URL של המאגר, שנוצרה על-ידי Git בשלב 4.

    אם לא יצרת הסתעפות בעבר, הזן רק את git push.

11. פתח את ההסלמה של הפרוייקט ב- GitHub ובחר את לחצן & השוואה בקשה למשיכה בתיבת ההצעות שמופיעה.

    

12. מלא את הכותרת והתיאור ובחר צור בקשת משיכה.

    

    אם יש תבנית עבור תיאור בקשת המשיכה, ה קח את הזמן כדי למלא את כל המידע הדרוש. אם אין עותק כזה כעת, הקפד לספק די הקשר כדי שמתחזקים יוכלו להבין אילו שינויים אתה מציע ומדוע. עליך גם לקשר בחזרה לבעיה הקשורה על-ידי אזכור המספר שלה באמצעות #<ISSUE_NUMBER>. תוכל למצוא את מספר הבעיה לצד הכותרת שלו.

    

העברת בדיקת המצב

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

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

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

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

בקש הדרכה או ביקורות לגבי בקשות משיכה

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

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

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

הגב להערות על בקשת המשיכה שלך

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

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