הגדל את מוניטין Github שלך עם הודעות התחייבות נכונות

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

כתוב הודעת התחייבות נכונה

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

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

הודעת התחייבות לדוגמא

להלן מראה הודעת התחייבות לדוגמא:

נוספה תמיכה ב- Docker, תכונה חדשה של is_unique, בתוספת תיקון באגים.
הוסיף תמיכה בהדרכת דוקר והוראות התקנה מעודכנות לפי הצורך. כללה גם תכונה חדשה בפונקציה check_order () לבדיקת ייחודיות, ותוקן באג קטן בעת ​​יצירת שבלולי מוצרים.
src / somedir / library.py: 381 - הוסיף פרמטר 'is_unique' לפונקציה check_order ().
src / products.py: 194 - באג קבוע בעת יצירת שבלול מוצרים.
docker-compose.yml - נוסף קובץ docker-compose.
docs / install.md - מדריך ההתקנה עודכן כדי לכלול כיצד להתקין דרך Docker.

מסר התחייבות

כשאתה מתחייב עכשיו, במקום להשתמש ב- -M הודעה, השתמש ב---קוֹבֶץ אוֹפְּצִיָה. לדוגמה, אם שם הקובץ של הודעת ההתחייבות שלך הוא commit.txt, היית מריץ את הפקודה:

git commit - file commit.txt

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

אשראי תמונה: כלב לבן /לא מתים