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