תרגיל - צור את בקשת המשיכה הראשונה שלך
למדת כיצד ליצור בקשת משיכה (PR) כאשר יש הדרכה בתבנית בקשת משיכה או בקובץ CONTRIBUTING. אך מה קורה אם פרוייקט אינו מציע הדרכה זו ותיעוד בנושא מוסכמות?
תאר את השינויים שלך
כדי לכתוב הודעת ביצוע טובה ולאחר מכן את בקשת המשיכה שלך, פעל בהתאם לנוהלי העבודה הבאים:
- שורת הנושא של הודעת הביצוע של Git אמורה להסתיים במשפט הבא:
- אם אפשרות זו מוחלת, ביצוע זה
<your subject line here>.
- אם אפשרות זו מוחלת, ביצוע זה
- כלול תיאור תמציתי של השינוי באמצעות זמן ההצגה ההוויה. לדוגמה, השתמש הוסף הוספת אומוסיפה.
- הגבל את שורת הנושא ל- 50 תווים.
- התחל באות רישית ואל תסתיים בנקודה (.).
- אתם יכולים להשתמש באימוג'ים או
@mentionבמשתמשי GitHub אחרים בשורת הנושא שלכם, אבל שימו לב שלא כל הפרויקטים מאפשרים או מעודדים זאת.
עבור גוף ההודעה ובקשה משיכה, המשך להשתמש ב'זמן מצגת'. הקפד לכלול את המוטיבציה לשינוי. ניגודיות השינוי עם אופן הפעולה הקודם. השתמש בשטח העומדים לרשותך כדי להסביר מה וכיצד לעומת כיצד.
הודעת הה ביצוע שלך נמצאת בנקודה זו בלבד כמו התוכן שאתה עומד לשלוח. בצע או שלח לסקירה של ערכות שינויים קטנות ומבודדות. תרגול זה מגדיל את הסבירות לכך שהשינויים שלך ימוזגו לתוך הפרוייקט.
הוסף צפיפות
לפני שתגיש את בקשת המשיכה, עיין בסרגל הצידי לקבלת דרכים להשלמת בקשת המשיכה. בחר בודקים או מקצה אם אתה מכיר את מבנה הצוות של הפרוייקט. הוסף תוויות כאשר יש הדרכה לשימוש בתוויות בקובץ ה- CONTRIBUTING.md, לדוגמה. באפשרותך להשתמש בתוויות כרמז חזותי למה שאתה מנסה להשיג. מתחזק עשוי גם להוסיף תווית או תוויות מרובות.
עצה
אם למאגר יש קובץ CONTRIBUTING.md או תבנית PR, עקוב אחר ההנחיות שלו בעת מילוי בקשת המשיכה שלך.
כמה מהתוויות שאנו משתמשים בהן במאגר עבור מודול Learn זה הן:
- באג (אדום): משהו לא פועל
- תיעוד (כחול): שיפורים או תוספות לתיעוד
- עותקים (אפור): בעיה זו או בקשת משיכה כבר קיימת
- שיפור (כחול-ים): תכונה או בקשה חדשה
באופן אופציונלי, באפשרותך לקשר בעיות הסרגל הצידי, שבו מיזוג בקשת משיכה בהצלחה עשוי לסגור את הבעיה המתאימה. באפשרותך גם להתאים אישית את המנוי הודעות בשרשור. חלק ממשתמשי ה- PRs מקבלים הערות רבות, ביקורות והודעות הקשורות ל- CI/CD. באפשרותך לבחור מבין:
- רשום כמנוי: לקבל הודעות רק כאשר השתתפת או היית @mentioned
- כמנוי: קבל את כל ההודעות עבור בקשת משיכה זו
- אישית: רק לקבל הודעה עבור האירועים שאתה בוחר
תרגיל
שימוש הראשונות, תרגול של שכפול, שכפול ושליחה של בקשת משיכה. פרויקט התרומות הראשונות שואף "להדריך את האופן שבו מתחילים עושים את התרומה הראשונה שלהם". הוא כולל מדריכים לשימוש בשורת הפקודה ובממשקי משתמש גרפיים (GUIs) אחדים. הפרוייקט כולל גם תמיכה בכמה שפות. הקפד לבדוק את Translations התיקיות.
לאחר שתחשבו על השיעורים ביחידה הקודמת ובשיעור זה, חזרו לבקשת משיכה שפתחת לאחרונה. לחלופין, באפשרותך לעבור אל הכרטיסיה בקשות משיכה של פרוייקט שאתה צופה בו. שים לב כיצד שורת נושא טובה יכולה לעשות את כל ההבדל. שקול לעדכן בקשת משיכה בהתאם. הוסף זמן בכתיבת בקשת המשיכה כפי שעשית בשינוי בפרוייקט. המאמצים שלך יסייעו למתחזקים לסווג ולתעדף (סדר עדיפויות) תרומות קהילה.
נוספות: את ההנחיות והדרישות של Microsoft בנושא נגישות. באופן ספציפי, עיין במידע אודות עם ממשק משתמש כדי להימנע משפה היכולת בתרומות שלך. לקוחות מקיימים אינטראקציה עם מוצרים באמצעות שיטות קלט שונות. לדוגמה, הם יכולים להשתמש בלוח המקשים, בעכבר, במגע, בקול ועוד. מומלץ להשתמש בפעלים כלליים הפועלים עם כל שיטת קלט. לדוגמה, השתמש בחר במקום בקלט ספציפי לקלט לחץ או החלק.