깃허브 컨벤션

 프로젝트 팀원끼리 Git을 사용하면서 Commit을 할 때 관련 메시지를 작성하는 규칙

 

혼자 프로젝트 할 때는 커밋을 본인만 알아볼 수 있으면 되지만, 여러 사람들과 함께 프로젝트 할 경우 컨벤션을 사용함으로써 프로젝트의 가독성을 높이고, 협업하는 작업자들 간의 의사소통을 원활하게 할 수 있다.

 

태그 이름	설명
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
style	코드 스타일 변경 (포매팅, 세미콜론 등)
refactor	코드 리팩토링
test	테스트 코드 추가
chore	빌드 업무나 패키지 매니저 수정 등
등등	. . .

자주 사용되는 태그

 

커밋메시지 예시

feat: 회원가입 기능 추가
fix: 로그인 오류 수정
docs: README 파일 업데이트
style: 코드 포맷 정리
refactor: API 호출 부분 리팩토링

---

EX)

feat: 회원가입 기능 구현 및 유효성 검사 추가

회원가입 시 입력한 데이터를 기반으로 유효성 검사를 수행하고, 
검사에 실패한 경우 사용자에게 에러 메시지를 반환하는 기능을 추가했습니다.

Resolves: #200
Fixes: #198
Closes: #150
Refs: #140
related to: #120
Co-authored-by: lsh <ish0542@naver.com>
BREAKING CHANGE: 회원가입 API 응답 형식이 변경되었습니다.

위 옵션 간략 설명 

1. Resolves: <해결한 이슈 번호>
2. Fixes: <해결된 버그나 이슈 번호>
3. Closes: <완료된 이슈 번호>
4. Refs: <참고한 이슈 번호>
5. related to: <관련된 이슈 번호>
6. Co-authored-by: <협업한 사람 깃허브 아이디>
7. BREAKING CHANGE: <프로젝트에 중요한 변경 사항 명시>