GitHub Issue Form YAML 생성기

GitHub Issue Form YAML 생성기 사용 가이드

GitHub Issue Form은 이슈를 글 상자가 아니라 입력 칸이 나뉜 양식으로 받게 해 줘, 빠진 정보를 필수 입력으로 막을 수 있습니다. 대신 YAML 문법을 정확히 써야 해서 처음 만들기가 까다로운데, 이 생성기가 기본 구조를 만들어 줍니다.

'입력 항목'의 각 항목이 body의 입력 칸이 됩니다. 브라우저, OS, 버전, 환경, URL이 들어간 항목은 한 줄 입력(input), 나머지는 여러 줄 입력(textarea)으로 만들고, 처음 두 항목은 필수(required: true)로 둡니다. id는 영문 항목 이름을 바꿔 만들고, 한글 이름처럼 영문이 없으면 field-3처럼 번호로 만듭니다.

모든 글자 값은 큰따옴표로 감싸 콜론이나 특수문자가 있어도 YAML 오류가 나지 않습니다.

사용 방법

1. 1'양식 이름 (예: 버그 신고)'과 '라벨 (쉼표로 구분)'을 적습니다.
2. 2'입력 항목 (쉼표나 줄바꿈으로 구분)'에 Description, Steps to reproduce, Browser처럼 받을 항목을 적습니다.
3. 3'실행' 후 '다운로드'로 받은 .yml 파일을 .github/ISSUE_TEMPLATE/ 폴더에 넣습니다.

양식 이름: Bug report
라벨: bug
입력 항목: Description, Steps to reproduce, 기대 결과, Browser

name: "Bug report"
description: "Bug report 양식입니다."
title: "[Bug report]: "
labels: ["bug"]
body:
  - type: textarea
    id: description
    attributes:
      label: "Description"
      description: "Description 내용을 적어 주세요."
    validations:
      required: true
  - type: textarea
    id: steps-to-reproduce
    attributes:
      label: "Steps to reproduce"
      description: "Steps to reproduce 내용을 적어 주세요."
    validations:
      required: true
  - type: textarea
    id: field-3
    attributes:
      label: "기대 결과"
      description: "기대 결과 내용을 적어 주세요."
    validations:
      required: false
  - type: input
    id: browser
    attributes:
      label: "Browser"
      description: "Browser 내용을 적어 주세요."
    validations:
      required: false

이럴 때 쓰면 좋아요

• 버그 신고에 필수 정보를 반드시 받게 할 때
• 기능 제안 양식을 입력 칸별로 정리할 때
• Markdown 이슈 템플릿을 Issue Form으로 바꿀 때
• YAML 문법이 익숙하지 않은 팀원이 양식을 만들 때

문제가 생겼을 때

활용 팁

• 필수 항목이 많을수록 신고 문턱이 높아집니다. 꼭 필요한 두세 개만 required: true로 두는 것이 좋습니다.
• Issue Form은 파일 확장자가 .yml이어야 합니다. .yaml이나 .md로 저장하면 양식으로 인식되지 않습니다.

자주 묻는 질문