Crear plantillas de problemas y de solicitudes de extracción

En esta página se describe cómo crear y configurar plantillas de incidencias y de solicitudes de extracción para Secure Source Manager.

Roles obligatorios

Para obtener los permisos que necesitas para trabajar con plantillas de incidencias y solicitudes de extracción, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos:

Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

Para obtener información sobre cómo conceder roles de Secure Source Manager, consulta los artículos Control de acceso con gestión de identidades y accesos y Conceder acceso a instancias a los usuarios.

Descripción general de las plantillas

Las plantillas de problemas y de solicitudes de extracción te permiten estandarizar la información que los colaboradores proporcionan a un repositorio. Las plantillas de incidencias ofrecen opciones predefinidas que los usuarios pueden elegir en función del tipo de incidencia que envíen y de los tipos de plantillas disponibles. Una plantilla de solicitud de extracción se aplica automáticamente a todas las solicitudes de extracción, lo que garantiza que las contribuciones al repositorio sean coherentes.

Cualquier persona con permiso para combinar archivos en un repositorio puede crear plantillas.

Crear una plantilla de incidencias

Secure Source Manager te permite definir plantillas de problemas mediante archivos Markdown en varias ubicaciones de tu repositorio. Puedes crear varias plantillas de incidencias para diferentes propósitos. Por ejemplo, puede que quieras tener plantillas independientes para informar de errores y enviar solicitudes de funciones.

  1. Crea una plantilla que empiece con la siguiente información, en este formato exacto:

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

  2. Proporciona un nombre y una descripción. Son obligatorios y se usan en la interfaz de usuario de la página Nuevos problemas.

  3. También puedes incluir un título que se use como título de marcador de posición cuando se cree un problema.

  4. Debajo del material obligatorio, incluya la información que quiera que se vea en la descripción del problema para ayudar a los usuarios a proporcionar la información necesaria.

  5. Guarda la plantilla como archivo Markdown en una de las siguientes ubicaciones:

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

Plantilla de problemas predeterminada

Secure Source Manager también admite la definición de una sola plantilla predeterminada. Esta plantilla debe definirse en una de las siguientes ubicaciones:

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

Cuando un usuario crea un problema, Gestor de fuentes seguras le pide que seleccione una plantilla (si hay alguna disponible) o selecciona la plantilla predeterminada. Si no hay ninguna plantilla predeterminada, no se rellenará nada en el nuevo problema.

Plantilla de problemas de ejemplo

Las cinco primeras líneas de la plantilla deben seguir las convenciones que se indican en el siguiente ejemplo. Cualquier información adicional se puede formatear en Markdown para adaptarse a las necesidades del tipo de 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:

Crear una plantilla de solicitud de extracción

  1. Crea una plantilla que empiece con la siguiente información, en este formato exacto:

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

  2. Debajo del material obligatorio, incluye la información que quieras que se vea en la descripción del problema para ayudar a los usuarios a proporcionar la información necesaria. Para obtener más información, consulta la plantilla de ejemplo de la siguiente sección.

  3. Guarda la plantilla como archivo Markdown en una de las siguientes ubicaciones de un repositorio:

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

Cuando creas una solicitud de extracción, Secure Source Manager comprueba si hay alguna plantilla en alguna de las ubicaciones definidas y la carga. Si has incluido información sobre el título en tu plantilla, se rellenará automáticamente en la nueva solicitud de extracción para proporcionar a los usuarios un formato definido que seguir. La información adicional que hayas incluido se añade a la descripción de la solicitud de extracción para que la actualice el usuario que la envía.

Plantilla de solicitud de extracción de ejemplo

Las tres primeras líneas de la plantilla deben seguir las convenciones que se muestran en el siguiente ejemplo. Todo lo que sigue son opciones que deberían ayudar a tus usuarios a crear solicitudes de extracción que sigan tus convenciones.

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

Siguientes pasos