• 목차

.github 폴더

• Github에서 프로젝트를 관리하는데에 사용되는 설정 파일들을 저장한다.
• Github Actions 사용을 위해서는 .github/workflows
• 이슈 템플릿의 경우에는 .github/ISSUE_TEMPLATE
• PR 템플릿의 경우에는 .github/PULL_REQUEST_TEMPLATE
  • 하나만 있는 경우에는 .github/PULL_REQUEST_TEMPLATE.md
• 특정 파일이나 디렉토리에 대한 기본코드 리뷰 담당자 지정 기능 .github/CODEOWNERS
• 프로젝트 기여 가이드의경우 .github/CONTRIBUTING.md 파일로 작성
• Depandabot을 통한 의존성 자동 업데이트 가능 .github/dependabot.yml
  • npm 사용해서 의존성 자동 업데이트
  • https://docs.github.com/ko/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates

Github Issue / PR 템플릿 작성

• Github Issue 템플릿의 경우는 MD(마크다운 형식), yml 을 통해서 사전에 정해둔 포맷을 사용할 수 있다.
• 이슈 템플릿의 위치는 .github/ISSUE_TEMPLATE/~~~.yml에 넣어주면 된다
  • ISSUE_TEMPLATE 폴더 내에 있는 경우 자동으로 인식되어 issue 작성 시에 template으로 보여진다.
  • yml 파일로 issue template 작성하는 방법: https://docs.github.com/ko/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

• PR 템플릿의 경우는 .github/PULL_REQUEST_TEMPLATE.md 파일을 이용하면 된다.

  • 마찬가지로 자동으로 인식해서 PR 요청 작성 시 자동으로 입력 된다.

    

Issue Template(yml)

name: Bug Fix 🛠️
description: 수정한 버그에 대한 내용을 정리할 때 사용하세요.
title: "[FIX] 제목을 입력하세요" # 이슈 제목 형식을 적어줄 수 있음
labels: ["bug fix"]  # 해당 라벨이 자동으로 붙음

body:
  - type: markdown
    attributes:
      value: |
        ## 🛠️ 버그 수정 내역
        수정한 버그와 관련된 상세 내용을 작성해주세요.

  - type: input
    id: bug-summary
    attributes:
      label: 🐞 버그 요약
      description: "수정한 버그를 간단히 요약해주세요."
      placeholder: "예: 로그인 시 500 오류 발생 문제 수정" # placeholder 역할

  - type: textarea
    id: root-cause
    attributes:
      label: 🔍 원인 분석
      description: "해당 버그의 근본 원인이 무엇인지 설명해주세요."
      placeholder: |
        예:
        - NullPointerException이 발생하여 500 오류가 발생
        - 로그인 요청 시 사용자 데이터가 정상적으로 반환되지 않음
    validations:
      required: false  # true인 경우 필수 항목이라 입력 안하면 Issue 생성 불가

  - type: textarea
    id: fix-details
    attributes:
      label: ✔️ 수정 내용
      description: "해당 버그를 어떻게 수정했는지 구체적으로 작성해주세요."
      placeholder: |
        예:
        - 로그인 API의 NullPointerException을 방지하기 위해 유효성 검사 추가
        - 사용자 데이터가 비어 있는 경우 기본값을 반환하도록 수정
    validations:
      required: false

  - type: textarea
    id: impact
    attributes:
      label: 🔍 영향을 준 부분
      description: "이번 수정이 영향을 줄 수 있는 코드나 시스템 부분을 설명해주세요."
      placeholder: |
        예:
        - AuthService 수정
        - 로그인 페이지 UI에서 새로운 에러 메시지 추가
        - Redis 세션 캐시 관련 기능 확인

  - type: input
    id: additional-context
    attributes:
      label: 📌 참고 사항
      description: "수정과 관련된 추가 정보나 참고할 만한 내용을 작성해주세요."
      placeholder: "예: 해당 수정이 Frontend 팀과의 협의가 필요함"