מדריך להעברת הודעות

שמירת ההודעות

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

לכל שמירה צריך להיות הפורמט:

<type>: <description>

[optional body]

[optional footer(s)]

חשוב לשים לב שמאגר blockly הליבה כולל קישור התחייבות שעוזר לאכוף זאת. אם לבקשת המשיכה יש כמה התחייבויות, הלינטר יבדוק את הכותרת. אם יש לה התחייבות אחת, היא תבדוק את ההתחייבות הזו. מומלץ שההתחייבות האישית שלכם וגם הכותרת של בקשת המשיכה יעמדו בהנחיות האלה.

תיאור

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

מטלה: להתחייבויות שמשלמות משימות שגרתיות/אוטומטיות, כמו תלות בשדרוג של תלות.
הוצא משימוש: להתחייבויות של פונקציונליות שהוצאה משימוש.
feat: להתחייבויות שמוסיפות פונקציונליות חדשה ל-Blockly.
fix: לביצוע פעולות לתיקון באגים או שגיאות ב-Blockly.
ביטול תלונה: להתחייבויות שקשורות לפרסום של גרסה חדשה.

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

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

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

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

התיאור

התיאור לא יכול להיות ריק ולא יכול להכיל יותר מ-256 תווים.

גוף

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

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

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

תיקון התחייבות לא קונבנציונלית

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

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