הנחיות לשליחה של מוצרי עבודה

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

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

הדוגמאות הטובות ביותר שראינו בשנים האחרונות נראות כמו "דוח סופי" שכולל:

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

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

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

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

דרישות

• חייבת להיות לכם אפשרות לזהות בקלות את העבודה שביצעתם. (כלומר, השינויים שביצעתם או קוד חדש).
  • כשמישהו נכנס לכתובת ה-URL, צריך להיות ברור איזו עבודה ביצעתם, בלי לבקש ממנו לבצע פעולות נוספות.
• היא צריכה להיות במיקום יציב. לא ניתן לשנות את כתובת ה-URL אחרי ששולחים אותה.
• צריך לאפשר למישהו אחר להשתמש בתוכן (או שיש אליו הפניה) ביעד של הקישור, כדי להרחיב את העבודה שלכם.
  • אם העבודה שלכם הושלמה ב-100%, אמורה להיות אפשרות להשתמש בה.
  • אם העבודה לא הושלמה ב-100%, צריך להיות ברור מה צריך לעשות.

דוגמאות טובות

לא צריך לבצע את כל הפעולות האלה (או חלק מהן), אבל יש כמה דרכים שבהן תוכלו לעמוד בדרישות.

• צרו פוסט בבלוג, דף אינטרנט או דף מידע ציבורי ב-GitHub, שמתאר את העבודה שעשיתם וקישורים להתחייבות שיצרתם ולמאגרים שעבדתם עליהם. אם יש עוד דברים לעשות בפרויקט, כדאי לכלול גם אותה. אפשר גם לשתף רגעים בולטים או קטעים מאתגרים.
  • ❗ זו האפשרות הטובה ביותר כי היא מאפשרת לכלול הרבה מידע בקלות. הקטע הזה טוב כי הוא יציג בבירור את העבודה שעבדתם עליו, וגם יעזור לאחרים להשתמש בקוד ולהבין אותו בקלות.
• אם אתם משתמשים ב-GitHub וכל העבודה שלכם נכללת בבקשת משיכה אחת, תוכלו להשתמש בקישור הזה.
  • יש לוודא שהתיאור של בקשת המשיכה מפורט. (למעלה, קראו את ההצעות לתוכן של הפוסטים בבלוג).
  • ודאו שהתיאור מציין בבירור שזה מיועד ל-Google Summer of Code.
  • אם בקשת המשיכה תעבוד יותר אחרי ש-GSoC הסתיימה, הקפידו לציין את ההתחייבות האחרונה ל-GSoC.
  • ❗ לכן כדאי להשתמש בדוגמה: יומן השינויים, רשימת התחייבויות ותגובות לבדיקה מרוכזים במקום אחד.
• אם המאגר ב-GitHub מיועד רק ל-GSoC, צריך להוסיף README.md עם פרטים נוספים.
• שולחים אימייל לרשימת הדיוור של המפתחים מהארכיון באופן ציבורי, עם הפרטים שלמעלה, וגם קישור אליה.
• צרו תיקייה ציבורית ב-Google Drive והוסיפו את כל התיקונים שיצרתם.
• יוצרים גיליון אלקטרוני ציבורי באמצעות Google Sheets ורושמים את כל ההתחייבויות.
• כדאי לקשר לבאג יחיד שמכיל בבירור הפניות ליצירה וכל תוכן רלוונטי אחר. הוא אמור לעקוב אחרי כל העבודה שעשית. ודאו שמוצג בה כל ההתחייבויות, או שיהיה קל למצוא אותן.
• קישור להבדלים מאוחדים או להקשר של השינויים. חשוב לכלול כותרת שמציינת לאיזה פרויקט הפרויקט משתייך ומי אתם, כך שזה יהיה שימושי לאחרים.

דוגמאות לתוויות לא תקינות

אין לבצע את הפעולות האלה.

• תוכלו לקשר ל-tarball או לקובץ ZIP שמכיל את כל קוד המקור של הפרויקט או את ספריית העבודה שלכם. (יותר מדי אנשים עשו זאת בעבר, זה לא מועיל לאנשים שרוצים להבין מה אתם עושים).
• קישור לחלק העליון של מאגר המקור הראשי של הפרויקט
  • כלומר, אם אתם עובדים על cpython, הקישור הזה לא מועיל: https://github.com/python/cpython
• קישור לשכפול של מאגר המקור של הפרויקט.
  • לכן קשה לראות מהם השינויים שביצעתם כי העבודה שלכם כוללת שילובים של אחרים.
• קישור לדף הפרויקט שלכם ב-GSoC.
  • אנחנו כבר יודעים מה זה. (כלומר https://summerofcode.withgoogle.com/projects/#1234567890)

מנטורים

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

כדאי לבדוק ש...

• ההגשה עומדת בדרישות שצוינו למעלה.
• הקוד עובר תהליך.
• יש תיעוד שמסביר מה ולמה.

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