협업의 첫 번째 단계 ③ git commit 컨벤션 이란?

이전 포스팅에 이어서 작성한 글입니다.
https://minha0220.tistory.com/65

 

 

 

 

이전 포스팅에서 github에 commit 하는 방법을 배웠습니다.

 

 

 

아래의 과정을 거쳐서

 

 

이렇게 pull request 과정까지 갔었습니다.

 

 

 

 

 

이 사진은 로컬 리포지토리에서 git push를 한 후에 원격 리포지토리에서 pull request를 진행하는 화면입니다.

(기억이 안나면 이전 포스팅을 참고해주세요)

 

 

이 화면에서 중요한 부분이 두 가지 있습니다.

 

 

 

 

 

 

 

 

보통 프로젝트를 진행할 때

 

1번은 commit 메세지와 2번은 commit 내용은 작성 규칙을 정해두고 진행을 합니다.

 

 

 

이 중에서 1번 commit 메세지는 git 컨벤션(Git Commit Message Convention)에 따라 작성하는게 관례입니다.

 

 

 

 

깃 커밋 메시지 컨벤션 (Git Commit Message Convention) 이란?

버전 관리 시스템에서 여러명의 개발자와 작업물을 관리 할 때 각 팀원들끼리 커밋 내역을 명시적으로 확인할 수 있도록 지켜지는 메세지 규약이다.
출처: https://jun0126.tistory.com/132

 

 

 

 

 

 

1. Git Commit Convention

 

 

 

초보 개발자가 모든 git 컨벤션을 지키기란 어렵습니다.

 

그래서 이 포스팅에서는 정말 기본적으로 사용되는 컨벤션만 소개드리려고 합니다.

 

 

 

 

 

<commit 타입>

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 작성
style : 코드 변경 없는 단순 수정(오타 수정, 세미콜론 추가 등)
refactor : 리팩토링
test : 테스트 코드
chore : 유지보수 및 빌드

 

 

 

위 박스에 있는 commit 타입을 보고 다시 한 번 pull request 화면을 봅시다.

 

 

 

 

 

 

 

 

commit 타입이 Docs이니 문서 작성을 했겠고,

 

문서 작성 내용은 readme.md 파일을 수정하는 작업임을 쉽게 짐작할 수 있습니다.

 

 

 

이렇듯 git 컨벤션 규칙을 지키는 이유는 commit 규칙을 통일해서 더 효율적으로 프로젝트를 진행하기 위해서 입니다.

 

 

 

 

 

2. Commit 내용

 

 

commit 내용은 git 컨벤션처럼 표준 규약이 정해져 있지는 않지만

 

프로젝트를 시작 할 때 팀원들끼리 작성 양식을 만들어놓고 진행을 합니다.

 

 

 

즉,

 

 

 

 

보통은 이렇게 대충 써서 올리지는 않는다는 것이죠.

 

 

 

 

아래는 예시입니다.

## :: 작업 내용
- [x] 기능 추가
- [ ] 리뷰 반영
- [ ] 리팩토링
- [ ] 버그 수정
- [ ] 컨벤션 수정
- [ ] 테스트

## :: 구현 목표
- 메인페이지, 검색결과페이지에서 필요한 데이터 추가

## :: 구현 사항 설명
1. 데이터 추가
- 위도, 경도
- 시설
- 평점
2. 금액 검색 조건 업데이트
- 1박당 금액에서 총 금액으로 수정
- 2박 3일, 20만원 이상의 숙소로 설정하면 1박에 10만원 이상의 숙소만 반환
3. 검색 기능 업데이트
- 지역이 '도'인 숙소를 검색하면, 지역에 '도'가 포함된 모든 숙소 반환
- 이름 '오름'인 숙소를 검색하면, 숙소 이름에 '오름'이 포함된 모든 숙소 반환

## :: 특이 사항
-  코드테스트 에러, 수정 예정

 

 

 

 

위 박스 내용을 2번 commit 내용에 올리면 이런 결과물이 나옵니다.

 

 

 

 

 

 

 

 

메인페이지와 검색걸과페이지에서 필요한 데이터를 추가하기 위해서 기능 추가를 했네요.

 

이를 위해서 데이터를 추가하고, 검색 기능을 업데이트 했습니다.

 

코드테스트를 하는데는 에러가 발생해서 수정 예정이라고 합니다.

 

 

 

 

이처럼 commit을 할 때는 어떤 내용을 commit 한건지 내용을 상세하게 작성해줘야 합니다.

 

 

 

 

 

 

 

 

 

이 두 가지만 지키면 기본적인 github 협업을 진행 할 수 있겠습니다.