建立問題和提取要求範本

本頁說明如何為 Secure Source Manager 建立及設定問題範本和提取要求範本。

必要的角色

如要取得處理問題和提取要求範本所需的權限，請要求管理員授予下列 IAM 角色：

  • Secure Source Manager 執行個體存取者 (roles/securesourcemanager.instanceAccessor) 在 Secure Source Manager 執行個體上
  • Secure Source Manager 存放區寫入者 (roles/securesourcemanager.repoWriter) 存放區

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

您或許還可透過自訂角色或其他預先定義的角色取得必要權限。

如要瞭解如何授予 Secure Source Manager 角色，請參閱「使用 IAM 控管存取權」和「授予使用者執行個體存取權」。

範本總覽

問題和提取要求範本可讓您標準化貢獻者提供給存放區的資訊。問題範本提供預先定義的選項，使用者可根據提交的問題類型和可用的範本類型選擇。提取要求範本會自動套用至所有提取要求，確保存放區的貢獻內容一致。

只要有權合併存放區中的檔案，任何人都可以建立範本。

建立問題範本

您可以在存放區的多個位置，使用 Markdown 檔案定義問題範本。您可以建立多個問題範本，用於不同用途。舉例來說，您可能想分別使用不同的範本回報錯誤和提交功能要求。

  1. 建立範本，開頭須為下列資訊，且格式完全相同：

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

  2. 提供名稱和說明。這些是必要屬性，會顯示在「新問題」頁面的使用者介面中。

  3. 您可以選擇加入標題，做為建立新問題時的預留位置標題。

  4. 在必要素材下方，加入您希望顯示在問題說明中的任何資訊，協助使用者提供必要資訊。

  5. 將範本儲存為 Markdown 檔案，並放在下列其中一個位置：

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

預設問題範本

Secure Source Manager 也支援定義單一預設範本。這個範本應定義在下列其中一個位置：

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

使用者建立新問題時，Secure Source Manager 會提示使用者選取範本 (如有)，或選取預設範本。如果沒有指定的預設範本，新問題就不會預先填入任何內容。

範例問題範本

範本的前 5 行必須遵循下列範例中列出的慣例。你可以使用 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 會檢查任何已定義的位置是否有範本，並載入範本。如果您在範本中加入標題資訊，系統會自動在新提取要求中填入該資訊，為使用者提供可遵循的格式。您加入的任何其他資訊都會新增至提取要求說明，並由提交要求的使用者更新。

提取要求範本範例

範本的前 3 行必須遵循以下範例所示的慣例。以下是各種選項，可協助使用者建立符合慣例的提取要求。

---
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. -->

後續步驟