זוהי הדף שאליו מפנים שאר מסמכי התיעוד. הוא מציין את שם כל שלב ביצוע כדי שניתן יהיה להתייחס במדויק למקום שבו משהו מתרחש.
הנתיב
your description
│
▼
specification what will be built, and how you will know it worked
│
▼
plan the ordered steps, reviewed before any code is written
│
▼
build code and tests written in an isolated workspace
│
▼
verify your test suite, plus checks and quality gates
│
▼
review an automated review pass over the diff
│
▼
pull request on a branch, in your repository, waiting for youמפרט
Coroid אינו מתחיל מהמשפט שלכם. ראשית הוא הופך את התיאור שלכם ל־ מפרט: מה ייבנה, מה נמצא באופן מפורש מחוץ להיקף העבודה, וקריטריוני הקבלה שיקבעו אם העבודה צלחה.
דבר זה חשוב מכיוון שקריטריוני הקבלה הם אלו ששלב האימות יבדוק נגדם מאוחר יותר. מפרט עמום מוביל לתוצאות קשות לשיפוט.
ניתן לקרוא ולערוך את המפרט ב־ מפרט כרטיסייה לפני תחילת הביצוע.
מדריך פיתוח מבוסס מפרט מסביר כיצד לכתוב קריטריונים שניתן לבדוק, לקבוע גבולות היקף ולשמור על אותה הגדרה של הצלחה לאורך תכנון, יישום וסקירה.
תכנון
עבור כל דבר מעבר לשינוי קטן, המפרט הופך ל־ תכנון: סדרה מסודרת של צעדים, המקובצים לשלבים. אתם מאשרים את התכנון לפני כתיבת הקוד.
דחיית תכנון היא פעולה זולה ונכונה כאשר הגישה אינה נכונה. דחייה לאחר כתיבת הקוד היא יקרה. זהו השלב שבו שיקול הדעת שלכם משפיע ביותר.
בנייה
סוכן מעתיק את מאגר הנתונים לסביבת עבודה מבודדת ופועל שם. הוא קורא את הקוד, כותב את השינוי ויוצר או מעדכן את הבדיקות.
סביבת העבודה היא חד־פעמית וייחודית לכל משימה. שום פעולה של הסוכן אינה משפיעה על ענף ברירת המחדל שלכם, ושתי משימות הפועלות בו־זמנית אינן יכולות לראות זו את עבודתה של זו.
אימות
חבילת הבדיקות שלכם פועלת ראשונה – זהו האות החזק ביותר הזמין, מכיוון שהיא משקפת את מה שצוותכם כבר קבע כחשוב.
בנוסף לכך, שערי איכות מפעילים את כל מה שהארגון שלכם הגדיר: סף כיסוי קוד, בדיקות סגנון קוד, סריקת אבטחה, בדיקות דפדפן נגד פריסת תצוגה מקדימה. שער חוסם עוצר את המשימה; שער מייעץ רושם ממצא ומאפשר המשך.
סקירה
סוכן הסקירה קורא את ההבדלים כפי שעמית היה קורא אותם ומפיק ממצאים. ממצאים שניתן לתקן נשלחים חזרה לתיקון; השאר מצורפים ל־pull request כדי שתוכלו לראותם.
לכן Coroid pull request מגיע כבר לאחר סקירה – לא כדי להחליף את הסקירה שלכם, אלא כדי שסקירתכם לא תהיה הראשונה.
בקשת משיכה
הענף נדחף ואז נפתחת בקשת משיכה של pull request אל ענף הבסיס שלכם, תוך שילוב השינוי, הבדיקות, תוצאות האימות וממצאי הסקירה.
Coroid נעצר כאן. המיזוג הוא באחריותכם.
מצבי משימות
מצב המשימה מראה היכן היא נמצאת בנתיב שצוין לעיל:
| מצב | משמעות |
|---|---|
PENDING | אושר, ממתין למקום פנוי בסוכן |
IN_PROGRESS | נמצא בעיבוד פעיל |
PENDING_REVIEW | העבודה הושלמה ונסקרה, ממתינה למיזוג או לאישור |
COMPLETED | סופקה |
NEEDS_HUMAN_REVIEW | Coroid אינו יכול להמשיך לבדו ודורש מכם תשובה |
PAUSED | נעצר זמנית, ניתן להמשך |
FAILED | הביצוע לא הצליח להסתיים |
CANCELLED | נעצר על ידכם |
WONT_FIX | נסגר במתכוון מבלי לבצע את העבודה |
מה קובע את קצב העבודה?
סוכן אחד מקום סוכן מבצע משימה אחת בכל פעם. מספר המקומות קובע כמה עבודה מתבצעת במקביל; הוא אינו מקצר את משך ביצועה של משימה בודדת. משך המשימה נקבע על ידי גודל השינוי ואורך זמן הבדיקות שלכם.
הבא
תפקידי סוכנים – איזה סוכן אחראי על איזה שלב, ומה מותר לו לעשות.