Crie modelos de problemas e pedidos de obtenção

Esta página descreve como criar e configurar modelos de problemas e modelos de pedidos de obtenção para o Secure Source Manager.

Funções necessárias

Para receber as autorizações de que precisa para trabalhar com problemas e modelos de pedidos de obtenção, peça ao seu administrador que lhe conceda as seguintes funções da IAM:

Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

Para obter informações sobre a concessão de funções do Secure Source Manager, consulte os artigos Controlo de acesso com o IAM e Conceda aos utilizadores acesso à instância.

Vista geral dos modelos

Os modelos de problemas e pedidos de incorporação permitem-lhe padronizar as informações que os colaboradores fornecem a um repositório. Os modelos de problemas oferecem opções predefinidas que um utilizador pode escolher consoante o tipo de problema que está a enviar e os tipos de modelos disponíveis. Um modelo de pedido de obtenção é aplicado automaticamente a todos os pedidos de obtenção, o que garante contribuições consistentes para o repositório.

Os modelos podem ser criados por qualquer pessoa com autorização para unir ficheiros num repositório.

Crie um modelo de problemas

O Secure Source Manager permite-lhe definir modelos de problemas através de ficheiros Markdown em várias localizações no seu repositório. Pode criar vários modelos de problemas para diferentes finalidades. Por exemplo, pode querer ter modelos separados para comunicar erros e enviar pedidos de funcionalidades.

  1. Crie um modelo que comece com as seguintes informações, neste formato exato:

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

  2. Indique um nome e uma descrição. Estes são obrigatórios e são usados na IU da página Novos problemas.

  3. Opcionalmente, pode incluir um título que é usado como um título de marcador de posição quando é criado um novo problema.

  4. Abaixo do material necessário, inclua todas as informações que quer que fiquem visíveis na descrição do problema e que ajudem os utilizadores a fornecer as informações necessárias.

  5. Guarde o modelo como um ficheiro Markdown numa das seguintes localizações:

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

Modelo de problemas predefinido

O Secure Source Manager também suporta a definição de um único modelo predefinido. Este modelo deve ser definido numa das seguintes localizações:

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

Quando um utilizador cria um novo problema, o Secure Source Manager pede-lhe que selecione um modelo, se estiverem disponíveis, ou seleciona o modelo predefinido. Se não existir um modelo predefinido designado, nada é pré-preenchido no novo problema.

Modelo de problemas de exemplo

As primeiras 5 linhas do modelo têm de seguir as convenções descritas no exemplo seguinte. Pode formatar quaisquer informações adicionais em Markdown para se adequarem às necessidades do 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:

Crie um modelo de pedido de obtenção

  1. Crie um modelo que comece com as seguintes informações, neste formato exato:

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

  2. Abaixo do material obrigatório, inclua todas as informações que quer que fiquem visíveis na descrição do problema para ajudar os utilizadores a fornecerem as informações necessárias. Consulte o modelo de exemplo na secção seguinte para mais detalhes.

  3. Guarde o modelo como um ficheiro Markdown numa das seguintes localizações dentro de um repositório:

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

Quando cria um novo pedido de obtenção, o Secure Source Manager verifica se existe um modelo em qualquer uma das localizações definidas e carrega-o. Se incluiu informações de título no seu modelo, estas são preenchidas automaticamente no novo pedido de obtenção para fornecer aos utilizadores um formato definido a seguir. Todas as informações adicionais que incluiu são adicionadas à descrição do pedido de obtenção para serem atualizadas pelo utilizador que o enviou.

Exemplo de modelo de pedido de envio

As primeiras 3 linhas do modelo têm de seguir as convenções apresentadas no exemplo seguinte. Tudo o que se segue são opções e devem ajudar os seus utilizadores a criar pedidos de obtenção que seguem as suas convenções.

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

O que se segue?