אופטימיזציה של העבודה עם הפרויקטים שלך ב- GitHub: היכרות עם מאגר תבניות Github

שלום לכולם, קהילת JavaRush! היום נדבר על קוד פתוח ומה נדרש כדי ליצור פרויקט באיכות גבוהה בנוסף לקוד שנכתב. חשוב לכתוב מוצר שימושי. אבל לא פחות חשוב הוא העיצוב הנכון של המאגר (מאגר פרויקטים ב-GitHub). זה יעזור ביישום נקודת מפתח נוספת - קידום מוצר. גם אם הפרויקט סופר מגניב, אבל אם הוא מעוצב בצורה גרועה, לא מתואר לפחות ב-README (תוכל לקרוא על מה זה README כאן ), הרישיון לא מצוין וכו' וכו', יהיו ללא הצלחה. רק שאף אחד לא ישים לב אליו. ואם מישהו שם לב, הוא לא יידע איך לתקשר איתו. יש הרבה דברים שצריך למלא שוב ושוב, ולא קל למתכנת להעתיק ולהדביק כל פעם, ובדיוק בשביל זה, הקיץ GitHub הוציאה את התכונה Template Repository שעוזרת בזה. כביכול, להפוך את תהליך יצירת הפרויקטים החדשים לאוטומטיים. היום נבין מה זה Repository ומה זה Template Repository. נתאר מה צריך להיות בפרויקט מלבד הקוד, באילו דברים אתה צריך להתמקד. בואו ניצור מאגר תבניות מאפס ונוסיף את כל הדרוש מנקודת המבט שלי. ולבסוף, נשתמש ב-Template Repository בעת יצירת מאגר חדש. אבל קודם כל, בואו נבין את התנאים. תיאוריה: מה צריך להיות במאגר הכללי של כל פרויקט לכל פרויקט קוד פתוח ב-GitHub צריך להיות פרופיל קהילה מתואר היטב , המכיל את האלמנטים הבאים.

1. תבנית הנפקה

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

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

דוגמה לאיך זה נראה ניתן לראות כאן .

2. רישיון

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

3. README

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

• סקירה כללית - תיאור קצר של הפרויקט;
• שימוש - כיצד להשתמש בפרויקט;
• בניין - איך להשיק פרויקט, מה צריך בשביל זה;
• פתרון בעיות - זה מתאר באילו בעיות אתה עלול להיתקל וכיצד לפתור אותן;
• הערות שחרור - תיאור השינויים בהתאם לגרסה;
• מחברים - אל תשכחו את יקיריכם;
• תורם - תיאור כיצד ניתן להשתתף בפיתוח הפרויקט;
• קוד התנהגות - תיאור כללי ההשתתפות;
• RELEASE_NOTES - קובץ שבו נרשמים כל השינויים עבור גרסאות חדשות. זה נוהג טוב לשים את זה במסמך נפרד ולאחסן קישור ב-README;
• CONTRIBUTING הוא קובץ שמתאר כיצד אתה יכול לתרום לפיתוח הפרויקט הזה. נוצר כקובץ נפרד עבור ה-Contributing header ב-README;
• CODE_OF_CONDUCT - קובץ המתאר את כללי ההשתתפות בפיתוח הפרויקט;
• Pull Request template - תבנית למי שייצור pull-request.

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

תרגול: יצירת תבנית משלך

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

1. הדבר הראשון שאתה צריך הוא חשבון ב- GitHub / להירשם שם .

2. צור מאגר חדש: כדי לעשות זאת, לחץ על + בפינה השמאלית העליונה

3. בעת היצירה, מלא:

   • שם המאגר - במקרה שלי repository-template;
   • תיאור - תיאור קצר של הפרויקט;
   • אנו עוזבים את Public, למרות שאתה יכול לבחור פרטי;
   • סמן את תיבת האתחול README:

   • בחר את הרישיון שלפיו הפרויקט יהיה:

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

     לכן, לחץ על Create Repository , ובכך להשלים את תהליך היצירה. המערכת תעביר אותנו אוטומטית למאגר החדש שנוצר.

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

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

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

   לחץ על הוסף , המערכת מבקשת ממך לבחור אמנת תורם או קוד התנהגות של אזרח :

   אני בוחר את הראשון ולוחץ על סקור ושלח .

   לאחר מכן, תוכל לערוך את הקובץ הזה ולבצע אותו.

   בתחתית, בחר באפשרות התחייב ישירות לסניף הראשי ולחץ על התחייב לקובץ חדש :

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

   תורם ותבנית הבעיה מתווספות בצורה דומה, אז אני לא אראה זאת. עשה זאת בעצמך ;)

5. הוסף תבנית Pull Request .

   אבל נדבר על זה בנפרד.

   אני לא יודע למה GitHub לא הוסיף את אותה אפשרות נוחה להגדרת תבנית Pull-Request, אז תצטרך ללמוד את התיעוד ולהוסיף אותו באופן ידני.

   כדי לעשות זאת, לחץ על צור קובץ חדש בשורש המאגר :

   שם הקובץ צריך להיות: .github/pull_request_template.md .

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

   כך יתמלא כל פרופיל הקהילה:

6. הוסף סמן של מאגר תבניות .

   כדי לעשות זאת, עבור אל אפשרות ההגדרות במאגר וסמן את התיבה שבה כתוב מאגר תבניות:

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

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

ישנן שתי אפשרויות לשימוש:

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

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

בואו נסכם את זה

במאמר זה הסתכלנו על:

• מהו מאגר GitHub;
• מהו מאגר תבניות;
• מה צריך להיות במאגר התבניות;
• כיצד ליצור מאגר תבניות;
• כיצד להשתמש במאגר תבניות.

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

קישורים שימושיים

• ארגון עם כל התבניות שיצרתי
• בלוג GitHub: צור מאגר חדש עם תבניות מאגר כיצד ליצור תבנית עבור מאגרים
• עזרה של GitHub: על מאגרים על מה הם מאגרים.
• עזרה של GitHub: יצירת מאגר מתבנית כיצד ליצור פרויקט חדש המבוסס על תבנית
• עזרה של GitHub: רישוי תיאור מאגר של רישוי לפרויקטים
• עזרה של GitHub: צור תיאור ריפו של יצירת מאגר
• מדריכי קוד פתוח טיפים ליצירה/תיאור של פרויקטים בקוד פתוח.
• עזרה של GitHub: הוספת תבנית pull-request - יצירת תבנית עבור pull-requests.

עוד מאמרים שלי

• איתור באגים ב- Intellij IDEA: מדריך למתחילים
• מדריך ליצירת לקוח עבור Skyscanner API ופרסום שלו ב-jCenter וב-Maven Central [חלק 1]
• מדריך ליצירת לקוח עבור Skyscanner API ופרסום שלו ב-jCenter וב-Maven Central [חלק 2]
• יצירת מערכת לניטור מחירי כרטיסי טיסה: מדריך שלב אחר שלב [חלק 1]
• יצירת מערכת לניטור מחירי כרטיסי טיסה: מדריך שלב אחר שלב [חלק 2]
• יצירת מערכת לניטור מחירי כרטיסי טיסה: מדריך שלב אחר שלב [חלק 3]
• רישום: מה, איך, איפה ועם מה?
• איך מבחן ראיון הפך לספריית קוד פתוח
• היסטוריה של הצלחה. 20 שעות תכנות שבועיות, תואר שני וחיים אישיים
• איך למצוא עבודה? טיפים לשליחת קורות חיים