TIL- Git Convention

2024-06-04

오늘의 학습 🌠

---

---

📌 Code Convention

---

Variable : Camel Case

Constant : Capital, Snake Case

종류	설명	표기법
변수	영문/숫자만을 사용해야 하고 카멜 표기법을 따라야 함.	camel case
상수	단어 간 구분을 위해 언더스코어(_)를 사용해야 함. 또한 대문자로만 표기해야 함.	scream snake case
패키지	패키지 이름은 소문자로만 구성되어야 함. 언더스코어(_)의 사용도 금지됨.	small letter
클래스	식별자 첫 단어는 대문자로 지정되고 서로 상이한 단어들을 구분 짓기 위해서 각단어의 시작을 대문자로 작성	upper camel case
메서드	이름은 동사로 시작해야함. 조회 메서드에는 where 절에 들어갈 파라미터명을 By 뒤에 써주면 가독성이 올라감.	lower camel case
boolean	앞에 is를 붙이고 파스칼 케이스를 적용함.	예시) isTrue
interface		upper camel case

• 메서드 예시
  • 조회 : load
    • loadCourseByCourseId()
  • 추가 : add
    • addCourse()
  • 수정 : modify
    • modifyCourse()
  • 삭제 : remove
    • removeCourse()

📌 Github Rule

---

• 기능 단위 별 브랜치 — 병합 → 디벨롭 브랜치 —최종병합→ 마스터 브랜치

📌 Git Commit Message

---

Feat : 회원 가입 기능 구현 

SMS, 이메일 중복 확인 API 개발 

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

• 제목 (Type : subject)

(’한줄 띄어 분리’)

• 본문 (Body)

(’한줄 띄어 분리’)

• 꼬리말 (Footer)

Subject

---

• 제목은 50글자 이내로 작성
• 첫글자는 대문자로 작성
• 마침표 및 특수기호는 사용하지 않음
• 과거시제 사용하지 않음

Body

---

• 선택사항으로 모든 커밋에 본문 내용을 작성할 필요는 없음

footer

---

• 선택사항으로 모든 커밋에 꼬리말을 작성할 필요는 없음
• 유형 : # 이슈 번호 형식으로 작성함

📌Github Commit Rule

---

작업 타입	작업내용
🎀 feat	새로운 기능 추가
✨ update	해당 파일에 새로운 기능이 생김
🎉 add	없던 파일을 생성함, 초기 세팅
🐛 bugfix	버그 수정
♻️ refactor	코드 리팩토링
🩹 fix	코드 수정
🚚 move	파일 옮김/정리
🔥 del	기능/파일을 삭제
🍻 test	테스트 코드를 작성
🙈 gitfix	gitignore 수정
🔨script	package.json 변경(npm 설치 등)

🐱‍🏍— —🤸🏻‍♀️ ~~~ 야~호~