이슈 및 풀 요청 템플릿 만들기

이 페이지에서는 Secure Source Manager의 문제 템플릿과 풀 요청 템플릿을 만들고 구성하는 방법을 설명합니다.

필요한 역할

문제 및 풀 요청 템플릿을 사용하는 데 필요한 권한을 얻으려면 관리자에게 다음 IAM 역할을 부여해 달라고 요청하세요.

역할 부여에 대한 자세한 내용은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

커스텀 역할이나 다른 사전 정의된 역할을 통해 필요한 권한을 얻을 수도 있습니다.

Secure Source Manager 역할 부여에 대한 자세한 내용은 IAM으로 액세스 제어사용자에게 인스턴스 액세스 권한 부여를 참고하세요.

템플릿 개요

문제 및 풀 요청 템플릿을 사용하면 기여자가 저장소에 제공하는 정보를 표준화할 수 있습니다. 문제 템플릿은 사용자가 제출하는 문제 유형과 사용 가능한 템플릿 유형에 따라 선택할 수 있는 사전 정의된 옵션을 제공합니다. pull 요청 템플릿은 모든 pull 요청에 자동으로 적용되어 저장소에 일관되게 기여할 수 있습니다.

템플릿은 저장소에서 파일을 병합할 권한이 있는 사용자가 만들 수 있습니다.

문제 템플릿 만들기

Secure Source Manager를 사용하면 저장소의 여러 위치에 있는 Markdown 파일을 사용하여 문제 템플릿을 정의할 수 있습니다. 다양한 용도로 여러 문제 템플릿을 만들 수 있습니다. 예를 들어 버그를 신고하고 기능 요청을 제출하는 템플릿을 별도로 만들 수 있습니다.

  1. 다음 정보를 정확한 형식으로 시작하는 템플릿을 만듭니다.

     ---
     name: TEMPLATE_NAME
     about: Insert description of template
     title: Placeholder title for the new issue when it is created
     ---
    
  2. 이름과 설명을 입력합니다. 필수이며 새 문제 페이지의 UI에서 사용됩니다.

  3. 새 문제가 생성될 때 자리표시자 제목으로 사용되는 제목을 선택적으로 포함할 수 있습니다.

  4. 필수 자료 아래에 문제 설명에 표시되어 사용자가 필요한 정보를 제공하는 데 도움이 되는 정보를 포함합니다.

  5. 다음 위치 중 하나에 템플릿을 마크다운 파일로 저장합니다.

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

기본 문제 템플릿

Secure Source Manager는 단일 기본 템플릿의 정의도 지원합니다. 이 템플릿은 다음 위치 중 하나에 정의되어야 합니다.

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

사용자가 새 문제를 만들면 Secure Source Manager에서 사용자가 템플릿을 선택하도록 프롬프트하거나(사용 가능한 템플릿이 있는 경우) 기본 템플릿을 선택합니다. 지정된 기본 템플릿이 없으면 새 문제에 아무것도 미리 채워지지 않습니다.

문제 예시 템플릿

템플릿의 처음 5줄은 다음 예에 설명된 규칙을 따라야 합니다. 추가 정보는 문제 유형의 요구사항에 맞게 마크다운으로 서식을 지정할 수 있습니다.

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

풀 요청 템플릿 만들기

  1. 다음 정보를 정확한 형식으로 시작하는 템플릿을 만듭니다.

     ---
     title: "[PR]: <Insert title>"
     ---
    
  2. 필수 자료 아래에 문제 설명에 표시하여 사용자가 필요한 정보를 제공하는 데 도움이 되는 정보를 포함합니다. 자세한 내용은 다음 섹션의 템플릿 예를 참고하세요.

  3. 템플릿을 저장소 내 다음 위치 중 하나에 마크다운 파일로 저장합니다.

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

새 풀 요청을 만들면 Secure Source Manager가 정의된 위치에 템플릿이 있는지 확인하고 템플릿을 로드합니다. 템플릿에 title 정보를 포함한 경우 사용자가 따라야 하는 형식을 제공하기 위해 새 풀 요청에 자동으로 채워집니다. 포함된 추가 정보는 제출 사용자가 업데이트할 수 있도록 풀 요청 설명에 추가됩니다.

풀 요청 템플릿 예시

템플릿의 처음 3줄은 다음 예에 표시된 규칙을 따라야 합니다. 다음에 나오는 모든 내용은 옵션이며 사용자가 규칙을 따르는 풀 요청을 만드는 데 도움이 됩니다.

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

다음 단계

  • Secure Source Manager에서 문제 및 풀 요청을 사용하는 방법에 관한 자세한 내용은 문제 및 풀 요청 작업을 참고하세요.