Vorlagen für Probleme und Pull-Anfragen erstellen

Auf dieser Seite wird beschrieben, wie Sie Vorlagen für Probleme und Pull-Anfragen für Secure Source Manager erstellen und konfigurieren.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie für die Arbeit mit Vorlagen für Probleme und Pull-Anfragen benötigen:

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Informationen zum Zuweisen von Secure Source Manager-Rollen finden Sie unter Zugriffssteuerung mit IAM und Nutzern Instanzzugriff gewähren.

Vorlagen – Übersicht

Mit Vorlagen für Probleme und Pull Requests können Sie die Informationen standardisieren, die Mitwirkende für ein Repository bereitstellen. Problemvorlagen bieten vordefinierte Optionen, aus denen ein Nutzer je nach Art des Problems, das er einreicht, und den verfügbaren Vorlagentypen auswählen kann. Eine Pull-Request-Vorlage wird automatisch auf alle Pull-Requests angewendet, um einheitliche Beiträge zum Repository zu gewährleisten.

Vorlagen können von allen Nutzern mit der Berechtigung zum Zusammenführen von Dateien in einem Repository erstellt werden.

Vorlagen für Probleme erstellen

Mit Secure Source Manager können Sie Vorlagen für Probleme mithilfe von Markdown-Dateien an mehreren Stellen in Ihrem Repository definieren. Sie können mehrere Vorlagen für Probleme für verschiedene Zwecke erstellen. Sie können beispielsweise separate Vorlagen für das Melden von Fehlern und das Einreichen von Funktionsanfragen verwenden.

  1. Erstellen Sie eine Vorlage, die mit den folgenden Informationen in diesem genauen Format beginnt:

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

  2. Geben Sie einen Namen und eine Beschreibung ein. Diese sind erforderlich und werden in der Benutzeroberfläche der Seite „Neue Probleme“ verwendet.

  3. Optional können Sie einen Titel angeben, der als Platzhalter verwendet wird, wenn ein neues Problem erstellt wird.

  4. Fügen Sie unter dem erforderlichen Material alle Informationen ein, die in der Problembeschreibung angezeigt werden sollen und Nutzern helfen, die erforderlichen Informationen anzugeben.

  5. Speichern Sie die Vorlage als Markdown-Datei an einem der folgenden Speicherorte:

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

Standardvorlage für Probleme

Secure Source Manager unterstützt auch die Definition einer einzelnen Standardvorlage. Diese Vorlage muss an einem der folgenden Speicherorte definiert werden:

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

Wenn ein Nutzer ein neues Problem erstellt, wird er von Secure Source Manager aufgefordert, eine Vorlage auszuwählen, sofern welche verfügbar sind. Andernfalls wird die Standardvorlage ausgewählt. Wenn keine Standardvorlage festgelegt ist, wird das neue Problem nicht automatisch ausgefüllt.

Beispielvorlage für Probleme

Die ersten fünf Zeilen der Vorlage müssen den Konventionen im folgenden Beispiel entsprechen. Zusätzliche Informationen können in Markdown formatiert werden, um den Anforderungen des jeweiligen Problemtyps gerecht zu werden.

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

Pull-Anfragevorlage erstellen

  1. Erstellen Sie eine Vorlage, die mit den folgenden Informationen in diesem genauen Format beginnt:

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

  2. Fügen Sie unter dem erforderlichen Material alle Informationen ein, die in der Problembeschreibung angezeigt werden sollen, um Nutzern zu helfen, die erforderlichen Informationen anzugeben. Weitere Informationen finden Sie in der Beispielvorlage im nächsten Abschnitt.

  3. Speichern Sie die Vorlage als Markdown-Datei an einem der folgenden Speicherorte in einem Repository:

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

Wenn Sie einen neuen Pull-Request erstellen, prüft Secure Source Manager, ob an einem der definierten Speicherorte eine Vorlage vorhanden ist, und lädt sie. Wenn Sie in Ihrer Vorlage Informationen zum Titel angegeben haben, werden diese automatisch in den neuen Pull-Request eingefügt, um Nutzern ein definiertes Format zu bieten, das sie befolgen können. Alle zusätzlichen Informationen, die Sie angegeben haben, werden der Beschreibung der Pull-Anfrage hinzugefügt, damit der Nutzer, der sie einreicht, sie aktualisieren kann.

Beispiel für eine Pull-Anfragevorlage

Die ersten drei Zeilen der Vorlage müssen den Konventionen im folgenden Beispiel entsprechen. Alles, was folgt, sind Optionen, die Ihren Nutzern helfen sollen, Pull-Requests zu erstellen, die Ihren Konventionen entsprechen.

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

Nächste Schritte