Créer des modèles de problèmes et de demande d'extraction;extraction

Cette page explique comment créer et configurer des modèles de problèmes et de demandes d'extraction pour Secure Source Manager.

Rôles requis

Pour obtenir les autorisations nécessaires pour utiliser les modèles de problèmes et de demande d'extraction, demandez à votre administrateur de vous accorder les rôles IAM suivants :

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Pour savoir comment accorder des rôles Secure Source Manager, consultez Contrôle des accès avec IAM et Accorder aux utilisateurs l'accès à l'instance.

Présentation des modèles

Les modèles de problèmes et de demande d'extraction vous permettent de standardiser les informations que les contributeurs fournissent à un dépôt. Les modèles de problèmes proposent des options prédéfinies parmi lesquelles un utilisateur peut choisir en fonction du type de problème qu'il signale et des types de modèles disponibles. Un modèle de demande d'extraction est automatiquement appliqué à toutes les demandes d'extraction, ce qui garantit des contributions cohérentes au dépôt.

Les modèles peuvent être créés par toute personne autorisée à fusionner des fichiers dans un dépôt.

Créer un modèle de problème

Secure Source Manager vous permet de définir des modèles de problèmes à l'aide de fichiers Markdown à plusieurs emplacements de votre dépôt. Vous pouvez créer plusieurs modèles de problèmes à des fins différentes. Par exemple, vous pouvez créer des modèles distincts pour signaler des bugs et envoyer des demandes de fonctionnalités.

  1. Créez un modèle qui commence par les informations suivantes, dans ce format exact :

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

  2. Indiquez un nom et une description. Ces éléments sont obligatoires et sont utilisés dans l'UI de la page "Nouveaux problèmes".

  3. Vous pouvez éventuellement inclure un titre qui sera utilisé comme titre de substitution lorsqu'un nouveau problème sera créé.

  4. Sous les éléments obligatoires, incluez toutes les informations que vous souhaitez voir figurer dans la description du problème et qui aideront les utilisateurs à fournir les informations nécessaires.

  5. Enregistrez votre modèle en tant que fichier Markdown dans l'un des emplacements suivants :

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

Modèle de problèmes par défaut

Secure Source Manager permet également de définir un seul modèle par défaut. Ce modèle doit être défini dans l'un des emplacements suivants :

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

Lorsqu'un utilisateur crée un problème, Secure Source Manager l'invite à sélectionner un modèle, s'il en existe, ou sélectionne le modèle par défaut. Si aucun modèle par défaut n'est désigné, rien n'est prérempli dans le nouveau problème.

Exemple de modèle de problèmes

Les cinq premières lignes du modèle doivent respecter les conventions décrites dans l'exemple suivant. Toute information supplémentaire peut être mise en forme en Markdown pour répondre aux besoins du type de problème.

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

Créer un modèle de demande d'extraction;extraction

  1. Créez un modèle qui commence par les informations suivantes, dans ce format exact :

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

  2. Sous les éléments obligatoires, incluez toutes les informations que vous souhaitez voir apparaître dans la description du problème pour aider les utilisateurs à fournir les informations nécessaires. Pour en savoir plus, consultez l'exemple de modèle dans la section suivante.

  3. Enregistrez le modèle en tant que fichier Markdown dans l'un des emplacements suivants d'un dépôt :

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

Lorsque vous créez une demande d'extraction, Secure Source Manager vérifie si un modèle existe dans l'un des emplacements définis et le charge. Si vous avez inclus des informations sur le titre dans votre modèle, elles sont automatiquement renseignées dans la nouvelle demande d'extraction d'extraction pour fournir aux utilisateurs un format défini à suivre. Toutes les informations supplémentaires que vous avez incluses sont ajoutées à la description de la demande d'extraction;extraction pour être mises à jour par l'utilisateur qui l'a envoyée.

Exemple de modèle de demande d'extraction

Les trois premières lignes du modèle doivent respecter les conventions indiquées dans l'exemple suivant. Tout ce qui suit est facultatif et devrait aider vos utilisateurs à créer des requêtes d'extraction qui respectent vos conventions.

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

Étapes suivantes