Criar modelos de problemas e solicitação de envio

Nesta página, descrevemos como criar e configurar modelos de problemas e de solicitação de extração para o Secure Source Manager.

Funções exigidas

Para receber as permissões necessárias para trabalhar com modelos de problemas e solicitação de envio, peça ao administrador para conceder a você os seguintes papéis do IAM:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.

Para informações sobre como conceder papéis do Secure Source Manager, consulte Controle de acesso com o IAM e Conceder acesso à instância aos usuários.

Visão geral dos modelos

Com os modelos de problemas e solicitação de envio, é possível padronizar as informações que os colaboradores fornecem a um repositório. Os modelos de problema oferecem opções predefinidas que um usuário pode escolher dependendo do tipo de problema que está enviando e dos tipos de modelos disponíveis. Um modelo de solicitação de envio é aplicado automaticamente a todas as solicitações de envio, garantindo contribuições consistentes para o repositório.

Os modelos podem ser criados por qualquer pessoa com permissão para mesclar arquivos em um repositório.

Criar um modelo de problemas

Com o Secure Source Manager, é possível definir modelos de problemas usando arquivos Markdown em vários locais do seu repositório. É possível criar vários modelos de problemas para diferentes finalidades. Por exemplo, você pode querer ter modelos separados para relatar bugs e enviar solicitações de recursos.

  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. Informe um nome e uma descrição. Eles são obrigatórios e usados na UI da página "Novos problemas".

  3. Você pode incluir um título que será usado como marcador de posição quando um novo problema for criado.

  4. Abaixo do material obrigatório, inclua as informações que você quer que apareçam na descrição do problema para ajudar os usuários a fornecer os dados necessários.

  5. Salve o modelo como um arquivo Markdown em um dos seguintes locais:

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

Modelo de problemas padrão

O Secure Source Manager também aceita a definição de um único modelo padrão. Esse modelo precisa ser definido em um dos seguintes locais:

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

Quando um usuário cria um novo problema, o Secure Source Manager pede que ele selecione um modelo, se houver algum disponível, ou seleciona o modelo padrão. Se não houver um modelo padrão designado, nada será preenchido previamente na nova edição.

Modelo de exemplo de problemas

As cinco primeiras linhas do modelo precisam seguir as convenções descritas no exemplo abaixo. Qualquer informação adicional pode ser formatada em Markdown para atender à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:

Criar um modelo de solicitação de envio

  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 as informações que você quer que apareçam na descrição do problema para ajudar os usuários a fornecer as informações necessárias. Consulte o modelo de exemplo na seção a seguir para mais detalhes.

  3. Salve o modelo como um arquivo Markdown em um dos seguintes locais dentro de um repositório:

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

Ao criar uma solicitação de envio, o Secure Source Manager verifica se um modelo existe em algum dos locais definidos e o carrega. Se você incluiu informações de título no modelo, elas serão preenchidas automaticamente na nova solicitação de envio para fornecer aos usuários um formato definido a seguir. Todas as informações adicionais incluídas são adicionadas à descrição da solicitação de envio para serem atualizadas pelo usuário que enviou.

Exemplo de modelo de solicitação de envio

As três primeiras linhas do modelo precisam seguir as convenções mostradas no exemplo a seguir. Tudo o que segue são opções e deve ajudar seus usuários a criar solicitações de pull que seguem 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. -->

A seguir