👉🏻 Git Commit convention

제목 : type : Subject
본문 : body(선택사항)
꼬리말 : footer(선택사항)

• 본문, 꼬리말은 좀 더 상세한 사항을 기록하기 위한 선택사항

• main으로 보이는 제목 부분을 공통 규칙에 따라 작성

• commit 제목 규칙

  1. ‘(type)Subject’ 형식으로 작성
  2. type은 소문자, Subject는 되도록 동사를 맨 앞에 두고 대문자로 시작
  3. commit message에 맞춰서 type 작성
     • add : 기초적 세팅 등 새로운 파일 추가
     • feat : 새로운 기능(모델, 함수) 추가
     • fix : 버그 수정, 코드 보완
     • test : 테스트 코드 추가
     • docs : 문서, 주석 추가 및 보완
     • remove : 코드나 문서 삭제

👉🏻 Code convention

• Model : lower snack case
• Class : upper carmel case
• Function : lower snack case
• Variable Value : lower snake case

👉🏻 코드 실명제

• 코드를 작성했을 경우,

Class ClassName(param):
	"""
		작성자 : OOO
	"""

• 코드를 작성 후, 리펙토링 과정을 거쳤을 경우,

Class ClassName(param):
	"""
		작성자 : OOO
		리펙터 : OOO
	"""