Skip to content

Issue-rule.md

Latest commit

 

History

History
212 lines (141 loc) · 4 KB

Issue-rule.md

File metadata and controls

212 lines (141 loc) · 4 KB
Raw

Issue Rule

Issue Rule 은
해야 할 작업, 버그, 개선 사항을
어떤 형식으로 기록하고 관리할지 정해두는 규칙이다.

Issue 를 잘 정리하면
무엇을 해야 하는지 명확해지고,
작업 우선순위도 잡기 쉬워진다.

특히 협업에서는
작업 시작 전에 Issue 를 먼저 만드는 습관이 유용하다.

1. 왜 필요한가

Issue 없이 작업하면
해야 할 일이 흩어지고
작업 목적이 불명확해질 수 있다.

예를 들어 아래 같은 문제가 생길 수 있다.

  • 어떤 기능을 왜 만드는지 기록이 없음
  • 버그 내용이 정확히 남지 않음
  • 문서 수정과 기능 수정이 섞임
  • 누가 어떤 작업을 하는지 헷갈림

그래서 작업 내용을 먼저 Issue 로 정리하면 좋다.

2. 기본 원칙

Issue 는
무엇을 왜 해야 하는지 바로 이해할 수 있게 작성하는 것이 좋다.

보통 아래 내용을 포함하면 충분하다.

  • 제목
  • 종류
  • 설명
  • 필요 이유
  • 작업 항목
  • 참고 사항

3. 제목 작성 규칙

제목은 짧고 명확하게 쓰는 것을 추천한다.

기본 형식은 아래처럼 맞추면 된다.

TYPE: short summary

example

  • FEAT: add login page
  • FIX: correct file upload path
  • DOCS: update README structure
  • CHORE: add .gitignore rule

4. 자주 사용하는 TYPE

FEAT

새 기능 추가

FIX

버그 수정

DOCS

문서 수정

REFACTOR

리팩토링

CHORE

설정, 기타 작업

TEST

테스트 관련 작업

5. 본문에 들어가면 좋은 내용

1) Summary

무슨 작업인지 간단히 적는다.

2) Reason

왜 필요한 작업인지 적는다.

3) Todo

해야 할 항목을 체크리스트로 정리한다.

4) Note

참고 사항이나 제한 사항을 적는다.

6. 추천 Issue 양식

template

  • Summary

    • 무엇을 해야 하는지 작성

  • Reason

    • 왜 필요한지 작성

  • Todo

    • 작업 1
    • 작업 2
    • 작업 3

  • Note

    • 참고 사항 작성

7. example

title

FIX: correct image path error

body

  • Summary

    • 이미지 경로 오류를 수정한다.

  • Reason

    • 특정 페이지에서 이미지가 정상적으로 표시되지 않는다.

  • Todo

    • 경로 확인
    • 코드 수정
    • 동작 확인

  • Note

    • 배포 경로 기준으로 다시 확인 필요

8. 작성 규칙 추천

1) 제목만 보고 작업 종류가 보여야 함

좋은 예:

  • DOCS: add branch rule

나쁜 예:

  • update
  • 작업
  • 해야함

2) 한 Issue 에 한 작업만 넣기

로그인 기능 추가와 README 수정을
한 Issue 에 같이 넣지 않는 것이 좋다.

3) 본문은 핵심만 쓰기

너무 길게 쓰기보다
작업자가 바로 이해할 수 있게 정리하는 것이 좋다.

4) 체크리스트 활용

해야 할 일을 Todo 로 쪼개 두면
진행 상태를 보기 쉽다.

5) 작업 전 Issue 먼저 만들기

특히 기능 추가나 버그 수정은
Issue 를 먼저 만들고 branch 를 따는 흐름이 좋다.

9. 자주 쓰는 흐름

기능 작업

  1. Issue 생성
  2. branch 생성
  3. 작업 진행
  4. commit
  5. Pull Request 생성
  6. merge 후 Issue 종료

10. 나쁜 예 / 좋은 예

bad

  • 제목이 fix
  • 본문 없음
  • 여러 작업이 한 Issue 에 섞여 있음
  • 왜 필요한지 설명 없음
  • 체크리스트 없음

good

  • 제목이 FEAT, FIX, DOCS 등으로 시작함
  • 작업 이유가 적혀 있음
  • Todo 가 정리되어 있음
  • 한 Issue 에 한 작업만 포함
  • 작업 흐름과 연결됨

11. 한 줄 정리

좋은 Issue 는
해야 할 작업을 명확하게 기록해서 작업 목적과 진행 상태를 쉽게 파악할 수 있게 만드는 것이다.