מדריך להודעות לגבי שינויים

הודעות לגבי השינוי

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

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

<type>: <description>

[optional body]

[optional footer(s)]

הערה: במאגר הליבה של Blockly יש כלי לבדיקת קוד (lint) של קומיטים, כדי לאכוף את זה. אם בקשת המיזוג כוללת כמה קומיטים, הכלי לבדיקת קוד יבדוק את הכותרת. אם יש לו קומיט אחד, הוא יבדוק את הקומיט הזה. מומלץ שגם ההתחייבויות האישיות וגם שם בקשת המיזוג יפעלו לפי ההנחיות האלה.

סוג

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

chore
לביצוע פעולות שגרתיות או אוטומטיות כמו שדרוג תלויות.
deprecate
לביצועי קומיט שגורמים להוצאה משימוש של פונקציונליות.
feat
לביצועי קומיט שמוסיפים פונקציונליות חדשה ל-Blockly.
fix
לביצוע פעולות Commit שמתקנות באגים או שגיאות ב-Blockly.
release
לביצוע פעולות Commit שקשורות להפצה של גרסה חדשה.

שינויי תוכנה שעלולים לגרום לכשלים

ב-commits שכוללים שינויים שוברים צריך להוסיף ! אחרי סוג ה-commit. שינויים שעלולים לשבור את הקוד הם שינויים שעלולים לגרום לבעיות למפתחים שמשתמשים ב-Blockly באפליקציות שלהם, ולחייב אותם לבצע עבודה נוספת.

לדוגמה: none fix!: return type of workspace.paste

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

תיאור

התיאור לא יכול להיות ריק, והוא צריך לכלול עד 256 תווים.

גוף

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

שימו לב: בדרך כלל מומלץ להוסיף את המידע הזה לתיאור של בקשת המיזוג, ולא ישירות לקומיט.

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

תיקון של קומיטים לא קונבנציונליים

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

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

  2. אם בקשת המיזוג כוללת קומיט אחד, משנים את הודעת הקומיט באמצעות git commit --amend ואז דוחפים את השינויים בכוח אל העותק המפוצל של Blockly. כל בקשות המיזוג הפתוחות שמשויכות לענף הזה יתעדכנו אוטומטית. git push --force origin my-branch.