Skip to content

Issue template

wynter24 edited this page Mar 6, 2025 · 2 revisions

issue template

✅Test template

  • 테스트 케이스 작성 및 실행 결과 기록 템플릿
name: '✅ TEST'
description: '테스트 케이스 작성 템플릿'
title: '✅ [Test] 제목'
labels: ['✅ Test']
body:
  - type: input
    id: test_overview
    attributes:
      label: '📄 테스트 개요'
      description: '테스트할 기능에 대한 간략한 설명을 작성해주세요.'
      placeholder: '예: 로그인 기능 테스트'
    validations:
      required: true

  - type: textarea
    id: test_scenario
    attributes:
      label: '🧪 테스트 시나리오'
      description: '테스트할 시나리오를 단계별로 작성해주세요.'
      placeholder: |
        예:
          1. 로그인 페이지로 이동
          2. 유효한 사용자 정보 입력
          3. 로그인 버튼 클릭
    validations:
      required: true

  - type: textarea
    id: expected_result
    attributes:
      label: '👓 예상 결과'
      description: '테스트 시나리오에 따른 예상 결과를 작성해주세요.'
      placeholder: '예: 사용자 대시보드로 이동해야 합니다.'
    validations:
      required: true

  - type: textarea
    id: actual_result
    attributes:
      label: '🖥️ 실제 결과'
      description: '테스트 실행 후 실제 결과를 작성해주세요.'
      placeholder: '실제 결과를 입력해주세요.'

✨Feature template

  • 작업 사항 기록 템플릿
name: '✨ Feature'
description: '새로운 기능 추가 템플릿'
title: '✨ [Feature] 제목'
labels: ['✨ Feature']
body:
  - type: textarea
    attributes:
      label: 📄 설명
      description: 새로운 기능에 대한 설명을 작성해 주세요.
      placeholder: 자세히 적을수록 좋습니다!
    validations:
      required: true
  - type: textarea
    attributes:
      label:  작업할 내용
      description:  일을 체크박스 형태로 작성해주세요.
      placeholder: 최대한 세분화 해서 적어주세요!
    validations:
      required: true
  - type: textarea
    attributes:
      label: 🙋🏻 참고 자료
      description: 참고 자료가 있다면 작성해 주세요.

♻️ Refactor template

  • 코드 리팩토링 기록 템플릿
name: '♻️ REFACTOR'
description: '코드 리팩토링 기록 템플릿'
title: '♻️ [Refactor] #관련 작업 이슈 번호'
labels: ['♻️ Refactor']

body:
  - type: input
    id: refactor_overview
    attributes:
      label: '📄 리팩토링 개요'
      description: '리팩토링의 목표나 이유를 간략하게 작성해주세요.'
      placeholder: '예: 중복 코드 제거, 성능 최적화'
    validations:
      required: true

  - type: textarea
    id: refactor_changes
    attributes:
      label: '✅ 변경 내용'
      description: '리팩토링한 코드의 주요 변경 사항을 간략히 설명해주세요.'
      placeholder: |
        예:
          - 함수 분리로 코드 재사용성 향상
          - 불필요한 변수 제거
    validations:
      required: true

  - type: textarea
    id: before_after_effect
    attributes:
      label: '🪄 변경 전후 효과'
      description: '리팩토링 전후의 차이점이나 코드 개선 효과를 작성해주세요.'
      placeholder: '예: 성능이 20% 개선됨, 코드 가독성 향상됨'

  - type: textarea
    id: additional_info
    attributes:
      label: '🙋🏻 기타'
      description: '추가적으로 기록할 내용이 있다면 작성해주세요.'
      placeholder: '예: 다음 단계에서 추가로 개선할 부분'

🐛Bug template

  • 버그 발생/해결 템플릿
name: '🐛 BUG'
description: '버글 발생/해결 템플릿'
title: '🐛 [Bug] 제목'
labels: ['🐛 Bug']
body:
  - type: markdown
    attributes:
      value: |
         기능이 구현되지 않거나 예상과 다르게 작동하는 경우:
        - 구현하고자  기능, 작성한 코드, 구현 방식 등을 상세히 설명하고, 문제가 발생한 에러 메시지를 첨부해주세요.
        - 필요시 이미지나 동영상을 함께 첨부해주세요.

         문제 해결 :
        - 제목에 Bug 이슈 번호를 포함하고, 문제 원인과 해결 방법을 코드와 함께 설명해주세요. (참고 링크가 있다면 함께 작성)

        - 필수 내용: 문제 상황, 코드, 에러 메시지, 이슈 번호 (해결한 경우)
        - 선택 사항: 이미지, 동영상, 참고 링크

         labels와 assignees를 연결해주세요.
         작업 완료 , projects, milestones, developments를 연결해주세요.

  - type: textarea
    attributes:
      label: 📄 문제상황
      description: 문제 상황을 상세하게 작성해주세요.
    validations:
      required: true
  - type: checkboxes
    attributes:
      label: ✔️ 재현 가능 여부
      description: 확인한 버그 상황을 재현 가능한지 여부를 체크해주세요.
      options:
        - label: '예'
        - label: '아니오'
  - type: textarea
    attributes:
      label: 💻 코드
      description: "코드 첨부시, VS Code 캡쳐본과 함께 해당 코드를 복사해서 올려주세요. \n 에러메시지가 있는 경우, 에러메시지 캡쳐본과 함께 에러메시지를 복사해서 올려주세요"
  - type: textarea
    attributes:
      label: 🙋🏻 참고 자료
      description: 이미지, 동영상, 참고 링크

Clone this wiki locally