יצירה של תבניות לבעיות ולבקשות משיכה

בדף הזה מוסבר איך ליצור ולהגדיר תבניות לבעיות ותבניות לבקשות משיכה ב-Secure Source Manager.

התפקידים הנדרשים

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

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

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

במאמרים בקרת גישה באמצעות IAM והענקת גישה של משתמשים למופע מוסבר איך נותנים תפקידים ב-Secure Source Manager.

סקירה כללית של התבניות

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

כל מי שיש לו הרשאה למזג קבצים במאגר יכול ליצור תבניות.

יצירת תבנית לבעיות

באמצעות Secure Source Manager, אפשר להגדיר תבניות של בעיות באמצעות קובצי Markdown בכמה מיקומים במאגר. אפשר ליצור כמה תבניות לבעיות למטרות שונות. לדוגמה, יכול להיות שתרצו תבניות נפרדות לדיווח על באגים ולשליחת בקשות לתכונות.

  1. יוצרים תבנית שמתחילה בפרטים הבאים, בפורמט הזה בדיוק:

     ---
 name: TEMPLATE_NAME
 about: Insert description of template
 title: Placeholder title for the new issue when it is created
 ---

  2. מזינים שם ותיאור. השדות האלה הם שדות חובה והם משמשים בממשק המשתמש של הדף 'בעיות חדשות'.

  3. אפשר גם להוסיף כותרת שתשמש ככותרת של placeholder כשנוצר נושא חדש.

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

  5. שומרים את התבנית כקובץ Markdown באחד מהמיקומים הבאים:

    • /.securesourcemanager/ISSUE_TEMPLATES/
    • /.securesourcemanager/issue_templates/

תבנית ברירת מחדל לבעיות

ב-Secure Source Manager אפשר גם להגדיר תבנית ברירת מחדל אחת. צריך להגדיר את התבנית הזו באחד מהמיקומים הבאים:

  • /.securesourcemanager/ISSUE_TEMPLATE.md
  • /.securesourcemanager/issue_template.md

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

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

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

---
name: Bug #Used as UI element for the button on the New Issues page
about: Use this template to submit a new bug #Used as description text on the New Issues page
title: [BUG]: <Describe issue> #Used as placeholder name for newly created issue
---
# Description

# Expected result

# Actual result

# Steps to reproduce
1.
2.

# Environment
-OS:
-Software version:
-Screenshots:

יצירת תבנית של בקשת משיכה

  1. יוצרים תבנית שמתחילה בפרטים הבאים, בפורמט הזה בדיוק:

     ---
 title: "[PR]: <Insert title>"
 ---

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

  3. שומרים את התבנית כקובץ Markdown באחד מהמיקומים הבאים במאגר:

    • /.securesourcemanager/PULL_REQUEST_TEMPLATE.md
    • /.securesourcemanager/pull_request_template.md

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

דוגמה לתבנית של בקשת מיזוג

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

---
title: "[PR]: <Insert title>"
---
<!-- Thank you for your contribution! -->

<!-- Include if applicable: -->
Fixes: #nnn <!-- tracking issues that this PR will close -->
**Related**: _Relevant tracking issues, for context_
**Merge before/after**: _Dependent or prerequisite PRs_

**Description**
<!-- Describe your changes here. The more detail, the easier the review! -->

**User facing changes (remove if N/A)**
<!-- Describe any user facing changes this PR introduces. -->
<!-- "Before" and "After" sections work great - bonus points for screenshots! -->
<!-- Be sure all docs have been updated as well! -->

**Follow-up Work (remove if N/A)**
<!-- Mention any related follow up work to this PR. -->

המאמרים הבאים