Creare modelli di issue e richieste di pull

Questa pagina descrive come creare e configurare i modelli di problemi e di richieste pull per Secure Source Manager.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per lavorare con i modelli di problemi e richieste di pull, chiedi all'amministratore di concederti i seguenti ruoli IAM:

Per ulteriori informazioni sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Per informazioni sulla concessione dei ruoli Secure Source Manager, consulta Controllo dell'accesso con IAM e Concedere agli utenti l'accesso all'istanza.

Panoramica dei modelli

I modelli di problemi e richieste pull consentono di standardizzare le informazioni che i collaboratori forniscono a un repository. I modelli di problemi offrono opzioni predefinite tra cui un utente può scegliere a seconda del tipo di problema che sta inviando e dei tipi di modelli disponibili. Un modello di richiesta di pull viene applicato automaticamente a tutte le richieste di pull, garantendo contributi coerenti al repository.

I modelli possono essere creati da chiunque disponga dell'autorizzazione per unire i file in un repository.

Creare un modello di problemi

Secure Source Manager consente di definire i modelli di problemi utilizzando file Markdown in più posizioni del repository. Puoi creare più modelli di problemi per scopi diversi. Ad esempio, potresti voler avere modelli separati per segnalare bug e inviare richieste di funzionalità.

  1. Crea un modello che inizi con le seguenti informazioni, in questo formato esatto:

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

  2. Fornisci un nome e una descrizione. Questi campi sono obbligatori e vengono utilizzati nell'interfaccia utente della pagina Nuovi problemi.

  3. Se vuoi, puoi includere un titolo che viene utilizzato come titolo segnaposto quando viene creato un nuovo problema.

  4. Sotto il materiale richiesto, includi tutte le informazioni che vuoi che siano visibili nella descrizione del problema e che aiutino gli utenti a fornire le informazioni necessarie.

  5. Salva il modello come file Markdown in una delle seguenti posizioni:

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

Modello di problemi predefinito

Secure Source Manager supporta anche la definizione di un singolo modello predefinito. Questo modello deve essere definito in una delle seguenti posizioni:

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

Quando un utente crea un nuovo problema, Secure Source Manager gli chiede di selezionare un modello, se disponibile, o seleziona il modello predefinito. Se non è presente un modello predefinito designato, non viene precompilato nulla nel nuovo problema.

Modello di esempio di problemi

Le prime 5 righe del modello devono rispettare le convenzioni descritte nell'esempio seguente. Eventuali informazioni aggiuntive possono essere formattate in Markdown per soddisfare le esigenze del tipo di problema.

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

Crea un modello di richiesta di pull

  1. Crea un modello che inizi con le seguenti informazioni, in questo formato esatto:

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

  2. Sotto il materiale richiesto, includi tutte le informazioni che vuoi che siano visibili nella descrizione del problema per aiutare gli utenti a fornire le informazioni necessarie. Per maggiori dettagli, consulta il modello di esempio nella sezione seguente.

  3. Salva il modello come file Markdown in una delle seguenti posizioni all'interno di un repository:

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

Quando crei una nuova richiesta di pull, Secure Source Manager verifica se esiste un modello in una delle posizioni definite e lo carica. Se hai incluso informazioni sul titolo nel modello, queste vengono compilate automaticamente nella nuova richiesta di pull per fornire agli utenti un formato definito da seguire. Eventuali informazioni aggiuntive che hai incluso vengono aggiunte alla descrizione della richiesta di pull da aggiornare dall'utente che la invia.

Esempio di modello di richiesta di pull

Le prime tre righe del modello devono seguire le convenzioni mostrate nell'esempio seguente. Tutto ciò che segue sono opzioni che dovrebbero aiutare gli utenti a creare pull request che seguano le tue convenzioni.

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

Passaggi successivi