CONTRIBUTING.md

IOJ 백엔드 기여 도움말

Branch

브랜치 이름은 다음과 같은 형식을 따릅니다.

<유형>/#<이슈 번호>

유형

유형	설명
build	빌드 시스템 또는 외부 종속성에 영향을 주는 변경 사항 (예: gradle, npm)
ci	CI 구성 파일 및 스크립트에 대한 변경 사항 (예: Github Actions, Dockerfile)
docs	문서 변경 사항 (예: README, API 문서)
feat	새로운 기능 추가
fix	버그 수정
perf	성능 개선
refactor	버그를 수정하거나 기능을 추가하지 않은 코드 리팩토링
test	누락된 테스트 추가 또는 기존 테스트 수정

Commit Message

다음 명령어를 사용하면 커밋 템플릿을 통해 커밋 메시지를 작성할 수 있습니다.

git commit

형식

커밋 메시지는 머리글, 본문, 바닥글로 구성됩니다.

<머리글>
<!-- 빈 줄 -->
<본문>
<!-- 빈 줄 -->
<바닥글>

머리글

필수입니다.

<유형>(<범위>): <짧은 요약>
  │    │         │
  │    │         └─⫸ 현재, 명령형으로 작성. 마침표 금지.
  │    │
  │    └─⫸ 커밋 범위: 이슈 번호|파일 이름|빈 값|...
  │
  └─⫸ 커밋 유형

유형

유형	설명
add	새로운 파일을 추가할 때
feat	새로운 기능을 추가할 때
fix	버그를 수정할 때
!HOTFIX	긴급한 심각한 버그를 수정해야 할 때
style	코드 형식 변경, 빠진 세미콜론, 코드 수정이 없을 때
refactor	프로덕션 코드를 리팩터링할 때
comment	필요에 따라 주석 추가 및 변경할 때
docs	문서를 수정할 때
test	테스트 추가, 테스트 리팩터링을 할 때 (프로덕션 코드 변경 없음)
chore	빌드 작업 업데이트, 패키지 매니저를 설정할 때 (프로덕션 코드 변경 없음)
rename	파일 또는 폴더 이름을 수정할 때
remove	파일 또는 폴더를 이동해야 할 때
delete	파일 또는 폴더를 삭제할 때

범위

선택 사항입니다.

관련된 이슈 번호나 파일이름을 작성합니다.

요약

변경사항이 "무엇"인지 작성합니다.

• 명령형, 현재 시제 사용: "변경함", "변경했음"이 아닌 "변경"으로 작성
• 끝에 마침표(.) 금지
• 한글 사용 권장
• 50자 이내로 작성

본문

docs 유형의 커밋을 제외하고 필수로 작성해야 합니다.

• 한 줄에 72자가 넘지 않도록 주의
• 어떻게 보다는 "무엇"을 "왜" 변경했는지 작성
• 자유로운 형식으로 작성

바닥글

• 참고 할 이슈 번호를 작성