⭐️ Final Project 19Team

LikeLion 백엔드 스쿨 5기 - 프로젝트 매칭 서비스

⭐️ 팀장님: 김희철
⭐️ 문원기
⭐️ 박혜진
⭐️ 신우석
⭐️ 이시윤

📝 커밋 컨벤션

1️⃣ 커밋 컨벤션이란?

커밋을 보낼 때 지켜야할 양식. 팀간의 협의를 통해 정한다.

커밋은 제목 + 내용 + (이슈 번호)로 이루어져 있다.

2️⃣ 제목

제목은 다음과 같은 방식으로 작성한다. type: title

type에는 커밋의 종류에 따라 다음과 같이 나뉜다.

Type	내용 설명
feat	기능 추가/수정 등
fix	버그 수정
docs	문서 수정
Comment	필요한 주석 추가 및 변경
style	스타일 변경 (형식, 세미콜론 누락 등)
refactor	리팩토링
test	테스트
chore	빌드, 패키지 관련 (업데이트 등)
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우

feat: User 엔티티 수정

3️⃣ 내용

내용에는 세부적인 변경 내용을 줄마다 -로 시작하는 형태로 적는다.

• User 엔티티에 email, location, phone 필드 추가
• User 엔티티에 Getter, Setter 범위 설정

내용은 한 줄 당 72자 내로 작성합니다. 내용은 양에 구애받지 않고 최대한 상세히 작성합니다. 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명합니다.

4️⃣ 이슈 번호

이슈 번호에는 만약 해당 커밋이 특정 이슈과 관련된 경우 "유형: #이슈 번호"의 형태로 작성한다. 관련된 이슈가 없다면 생략이 가능하다. 여러 개의 이슈 번호를 적을 때는 쉼표로 구분합니다.

유형	이슈번호
Fixes	이슈 관련 내용 수정중 (아직 해결되지 않은 경우)
Resolves	이슈 관련 내용 수정 완료
Ref	참고할 이슈가 있을 때 사용
Related to	해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

Resolves: #123 Ref: #456 Related to: #48, #45

전체 예시

Feat: 추가 로그인 함수

- 로그인 API 개발

Resolves: #123    # 이슈 해결했을 때 사용
Ref: #456    # 참고할 이슈가 있을 때

📝 코드 작업 방식

1️⃣ 자기 이름으로 브랜치 생성하기

레포지토리를 클론해서 가져온 후, intelliJ에서 dev 브랜치로 checkout한다.
그 후에 new Branch하여 자신의 이름을 적고 브랜치를 생성한다.

2️⃣ 작업하기

자신의 코드를 추가한다.

3️⃣ 커밋하기

커밋 컨벤션 양식을 지켜서 커밋한다.
인텔리제이에서 커밋할 파일을 ctrl + alt + a 하여 add한 후에, ctrl + k 하여 커밋 창을 띄운다.
커밋 창에서 커밋 컨벤션 양식을 지켜서 커밋 문을 작성한다.
여기서 중요한 것은 커밋 컨벤션 양식을 지키고 이번 커밋에 포함할 파일을 적절히 선택하여 커밋하는 것이다.
한 커밋에 모든 파일을 보내기 보다는 코드 리뷰하기 쉽도록 분류해서 나눠서 커밋하는 것이 좋다.

4️⃣ git bash에서 push하기

인텔리제이에서 push가 되지 않을 수도 있다.
그럴 때는 git bash를 프로젝트 폴더 (Final_Project_19Team)에서 키고, git push --set-upstream origin 브랜치이름 을 해주면 된다.
처음 한번만 해주면 그 뒤론 git bash에서 'git push' 한 번만 입력해도 push가 가능하다.

5️⃣ Pull Request 만들기

이 과정은 혼자서 진행하지 말고, 팀원들에게 물어보면서 진행하자.
github 홈페이지에서 레포지토리로 들어간 후에, 자신의 브랜치로 들어간다.
그곳에 있는 create pull request를 클릭해서 절차대로 진행하면 된다.