Skip to main content

리포지토리에 대한 단일 문제 템플릿 수동으로 만들기

리포지토리에 수동으로 만든 문제 템플릿을 추가하면 프로젝트 기여자가 문제 본문에서 템플릿의 콘텐츠를 자동으로 볼 수 있습니다.

이슈 템플릿을 만드는 레거시 워크플로입니다. 업그레이드된 다중 이슈 템플릿 작성기 또는 이슈 양식을 사용하여 이슈 템플릿을 만드는 것이 좋습니다. 자세한 내용은 "문제 및 끌어오기 요청 템플릿 사용"을 참조하세요.

지원 폴더에 ISSUE_TEMPLATE/ 하위 디렉터리를 만들어서 다중 문제 템플릿을 포함하고 template 쿼리 매개 변수를 사용하여 문제 본문을 채울 템플릿을 지정할 수 있습니다. 자세한 내용은 "문제 만들기"을(를) 참조하세요.

각 문제 템플릿에 YAML 프런트매터를 추가하여 문제 제목을 미리 채우고, 레이블 및 담당자를 자동으로 추가하고, 다른 사용자가 내 리포지토리에서 새 문제를 만들 때 볼 수 있는 템플릿 선택기에서 표시되는 이름과 설명을 템플릿에 제공할 수 있습니다.

다음은 YAML 프런트매터의 예시입니다.

---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat
---

참고: 앞의 문제 값에 YAML 예약 문자(예: : )가 포함된 경우 전체 값을 따옴표로 넣어야 합니다. 예를 들어 ":bug: Bug" 또는 ":new: triage needed, :bug: bug"입니다.

검사마크를 커뮤니티 프로필 검사 목록에 표시하려면 문제 템플릿이 .github/ISSUE_TEMPLATE 폴더에 있어야 하며 유효한 name: 및 YAML 프런트매터(.md 파일에 정의된 문제 템플릿의 경우)의 about: 키 또는 name:description: 키(.yml 파일에 정의된 문제 양식의 경우)에 있어야 합니다.

기본 문제 템플릿을 만들고 조직 또는 개인 계정에 대한 문제 템플릿의 기본 구성 파일을 만들 수 있습니다. 자세한 내용은 "Creating a default community health file(기본 커뮤니티 상태 파일 만들기)"을 참조하세요.

문제 템플릿 추가

  1. GitHub.com에서 리포지토리의 기본 페이지로 이동합니다.

  2. 파일 목록 위에서 파일 추가 드롭다운 메뉴를 선택하고 새 파일 만들기를 클릭합니다.

    또는 왼쪽의 파일 트리 보기에서 을(를) 클릭합니다.

    리포지토리의 기본 페이지  스크린샷. 파일 목록 위에 "파일 추가" 레이블의 단추가 진한 주황색으로 표시됩니다. 리포지토리의 파일 트리 보기에서 더하기 기호 아이콘이 있는 단추도 진한 주황색으로 표시됩니다.

  3. 파일 이름 필드에서 다음을 수행합니다.

    • 리포지토리의 루트 디렉터리에 문제 템플릿을 표시하려면 issue_template 이름을 입력합니다. 예: issue_template.md.
    • 리포지토리의 docs 디렉터리에 문제 템플릿을 표시하려면 docs/ 다음에 issue_template 이름을 입력합니다. 예시: docs/issue_template.md.
    • 파일을 숨겨진 디렉터리에 저장하려면 .github/ 다음에 issue_template 이름을 입력하세요. 예: .github/issue_template.md.
    • 여러 문제 템플릿을 만들고 template 쿼리 매개 변수를 사용하여 문제 본문을 채울 템플릿을 지정하려면 .github/ISSUE_TEMPLATE/ 을 입력한 다음 문제 템플릿의 이름을 입력합니다. 예: .github/ISSUE_TEMPLATE/issue_template.md. 루트 또는 docs/ 디렉터리 내의 ISSUE_TEMPLATE 하위 디렉터리에 여러 문제 템플릿을 저장할 수도 있습니다. 자세한 내용은 "문제 만들기"을(를) 참조하세요.
  4. 새 파일의 본문에 문제 템플릿을 추가합니다. 여기에는 다음이 포함될 수 있습니다.

    • YAML 프런트매터
    • 예상 동작 및 실제 동작
    • 문제를 재현하기 위한 단계
    • 프로젝트 버전, 운영 체제 또는 하드웨어
  5. 변경 내용 커밋... 을 클릭합니다.

  6. "커밋 메시지" 필드에, 파일의 변경 내용을 설명하는 커밋 메시지를 간결하고 명확하게 입력합니다. 커밋 메시지에서 둘 이상의 작성자가 커밋의 특성을 지정할 수 있습니다. 자세한 내용은 "여러 작성자와 커밋 만들기"을 참조하세요.

  7. 커밋 메시지 필드 아래에서 현재 분기 또는 새 분기에 커밋을 추가할지 여부를 결정합니다. 현재 분기가 기본 분기인 경우 커밋에 대한 새 분기를 만든 다음 끌어오기 요청을 만들도록 선택해야 합니다. 자세한 내용은 "끌어오기 요청 만들기"을 참조하세요.

    기본 분기에 직접 커밋하거나 새 분기를 만드는 라디오 단추를 보여 주는 GitHub 끌어오기 요청의 스크린샷. 새 분기를 선택했습니다. 템플릿과 같은 사양은 협력자가 리포지토리의 기본 분기에 병합할 때 사용할 수 있습니다.

  8. 변경 내용 커밋 또는 변경 내용 제안을 클릭합니다.

추가 참고 자료