כיצד אוכל להכין ולהעלות פרוייקט קיים ל- GitHub?
ביחידה זו, נדון בשיקולים החשובים להעלאת פרוייקט ל- GitHub.
מדוע כדאי להעלות ל- GitHub?
ישנם כמויות של ספרות המלהיטות את היתרון של GitHub, וזה מעבר להיקף של מודול זה כדי לשכנע אותך להצטרף. עם זאת, במודול זה אנו מסכם כמה מהיתרונות העיקריים בהקשר של נושאים שעליך לשקול בעת תכנון ההעלאה.
בקרת גירסאות
GitHub משתמש באופן בלעדי Git, ללא ספק במערכת בקרת הגירסאות הטובה ביותר בסביבה. עם זאת, Git הוא מתוחכם מאוד והוא יכול ליצור כמה תרחישים מורכבים לעבודה עם קוד שייתכן שהצוות שלך לא מנוסה איתו. ענפים ו- בקשות משיכה הן חלק מהותי בחיי היום-יום עבור מפתחים המשתמשים ב- Git, כך שהבנה מתי ואופן השימוש בהם ביעילות נחוצה כדי מוצלחת ב- GitHub. כדאי שהצוות שלך יהיכרות תחילה עם הזרימה של GitHub כדי שתוכל להכות את הקרקע בריצה.
שמור את הקוד שלך בענן
כמות גדולה של קוד פרוייקט עדיין מאוחסנת באופן בלעדי במחשבים למפתחים. בעת העלאה ל- GitHub, אתה מעביר את הקוד שלך לפלטפורמות הענן של GitHub, שבה חברי צוות יכולים לגשת אליו בקלות מכל מקום. שינוי זה מציע הזדמנות טובה לסקור את מדיניות הצוות שלך לגבי סוגי הקבצים והנתונים שאתה שומר בפקדי גירסאות. כשיטת עבודה מומלצת, עליך להניח כי כל מה שאתה מתחייב ל- GitHub עלול להיות בסכנה. לכן, הקפד לא לכלול נתונים רגישים, כגון מפתחות API, סיסמאות או קבצים אחרים המכילים מידע השוואה.
הערה
GitHub מציע מאגרים ציבוריים ופרטיים, ופקדי גישה פרטנית עבור חלקים שונים של מאגר. צפיפות זו מאפשרת לך לקבוע למי הפרוייקטים שלך גלויים ולאילו פעולות משתמש נתון יכול לבצע.
שיתוף פעולה
GitHub מציע תמיכה מעולה בשיתוף פעולה בין צוותים באמצעות תכונות כגון בעיות, בקשות משיכה וביקורות קוד. עם זאת, זרימת GitHub עשויה להיות שונה מהשיטות שבהן הצוות שלך מורגל כעת. מומלץ לשקול כיצד הצוות שלך מסתגל ל- GitHub, ואם כדאי לך לשמור תהליכים קיימים.
אם הפרוייקט שלך הוא פרוייקט קוד פתוח שמאפשר משתתפים חיצוניים, אין אפשרות טובה יותר מ- GitHub להגדלת היתרונות הללו.
העלאה ל- GitHub
שיקולי תוכנית
הדבר החשוב ביותר שיש לשקול לפני ביצוע ההעלאה ל- GitHub הוא אם עליך לשמור משהו מעבר למצב הנוכחי של המקור שלך. לדוגמה, באפשרותך להשתמש בגיליון אלקטרוני או בתוכנה לניהול פרוייקטים כדי לעקוב אחר באגים שבכוונתך לתקן. התמיכה בהעברת פריטים אלה משתנה לפי פלטפורמה, והיא זמינה בדרך כלל מפרוייקטים של הקהילה. מודול זה אינו מכסה העברת נתונים מסוג זה.
טיפול בקבצים בינאריים המאוחסנים כעת בפרוייקט שלך
כשיטת עבודה מומלצת, מאגרי GitHub צריכים להיות מוגבלים לקבצים הדרושים לבניית פרוייקטים. הימנע מביצוע קבצים בינאריים גדולים, כגון ממצאי Build. קבצים בינאריים כגון גליונות אלקטרוניים ומצגות מתאימים יותר למעקב בפורטלים שמבינים כיצד לשרת אותם ולבצע בהם גירסאות כראוי. אם יש לך צורך בגירסה של קבצים בינאריים גדולים, שקול להשתמש בסיומת Git Git LFS (אחסון קבצים גדולים).
צור קבצי Git חשובים כגון .gitignore
Git תומך .gitignore קבצים כדי לסייע באכיפת מדיניות קבצים של בקרת גירסאות. קבצים אלה מגדירים את דפוסי החיפוש המשמשים כדי לא לכלול קבצים ותיקיות במעקב אחר בקרת מקור. הדוגמה הבאה, רקורסיבית, אינה כוללת תיקיות הנקראות Bin או binואת התוכן שלהן, במעקב אחר בקרת מקור.
[Bb]in/
קבל מידע נוסף התעלמות מקבצים. עיין גם באוסף של קבצי .gitignore להפעלה המוצעת עבור פלטפורמות שונות במאגר gitignore.
קיימים כמה קבצים אחרים שנמצאים בשימוש נפוץ בפרוייקטי GitHub כדי להסביר פריטי מדיניות שונים לצרכנים ולמשתתפים במאגר. גם אם הפרוייקט שלך הוא פרטי והוגבל לקהל מוגבל, הוא עדיין יכול להיות שימושי כדי לבטא פריטי מדיניות אלה באופן מפורש. אף אחד מקבצים אלה אינו נדרש, אך כמה מהקבצים הנפוצים מפורטים כאן.
| קובץ | תכלית |
|---|---|
README.md |
דף היעד של מדריך הכתובות. דף זה מעובד כאשר מדריך הכתובות שלו מוצג ב- GitHub. |
LICENSE.md |
קובץ זה מכיל את הרשיון שתחתיו מסופק הקוד. |
CONTRIBUTING.md |
מסביר כיצד המשתמשים צריכים לתרום לפרוייקט, כגון ציפיות בקשת משיכה. |
SECURITY.md |
מסביר את מדיניות האבטחה עבור הפרוייקט. קובץ זה מספק הדרכה למשתמשים הברצונך לשלוח קוד רגיש הקשור לאבטחה או משוב שאין לחשוף בפומבי לפני ההדרכה. |
קבל מידע נוסף הגדרת הפרוייקט שלך לתרומות בריאות.
העלאת הפרוייקט שלך ל- GitHub
לאחר שהמאגר שלך מוכן להעלאה, צור מאגר ב- GitHub. לאחר יצירתו, נווט ה- של מאגר GitHub. תצוגה זו מספקת כמה דרכים להעלאת קוד הפרוייקט שלך.
אנו ממליצים להשתמש ב- git או בכלי ידידותי ל- Git כדי להעלות את המקור שלך. לחלופין, באפשרותך להעלות את הקבצים שלך באופן באמצעות הקישור ליצירת קובץ חדש. לטווח הארוך, אתה צפוי לגלות שהשימוש בלקוח git הוא הדרך הטובה ביותר לנהל שינויים, הסתעפויות ועוד.