Git_Github

Git Commit Convention

WEB_CREASTORY 2024. 3. 10. 22:26

코드 컨벤션 예시

✅ 태그 이름설명

Feat 새로운 기능을 추가할 경우
Fix 버그를 고친 경우
Design CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE 커다란 API 변경의 경우
!HOTFIX 급하게 치명적인 버그를 고쳐야하는 경우
Style 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor 프로덕션 코드 리팩토링
Comment 필요한 주석 추가 및 변경
Docs 문서를 수정한 경우
Test 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove 파일을 삭제하는 작업만 수행한 경우

 

✅ 코드 컨벤션

TypeScript Code Converntion

  • 타입을 명시해보는데 모르는 타입이 있다면 unknown 사용(안된다면 any)
  • 변수명/함수명 : Camel case / ex) camleCase
  • Class명 : Pascal Case / ex) PascalCase
  • 문장 끝엔 (;) 세미콜론을 사용합니다.
  • 싱글 따옴표를 사용합니다.
  • .perttierrc.json
{
  "trailingComma": "es5", 
  "tabWidth": 2,
  "semi": true,
  "singleQuote": true,
  "arrowParens": "always",
  "printWidth": 80
}
  • 확장 프로그램으로 사용시 설정
  • 검색어 - format

  • 함수명은 동사 + 명사 형태로 합니다.
    • 동사는 현재, 과거분사만 사용합니다.Plain Text복사
getUserInfomation()
  • 폴더명은 소문자 명사 형태로 작성합니다.
    • 단/복수는 각자의 코드 상황에 맞게 설정합니다.
/users
/posts
/stores
/database
/cache
  • 파일명은 . 을 통해 구분
  • comments.service.ts
  • 연산자 사이 space 씁니다.
  • const sum = 1 + 1;
  • 주석 규칙
    • 설명이 필요하다고 여기는 부분은 주석을 달아주세요.
    • Better Comments
    (초록) // * : 기능 주석
(빨강) // ! : 문제가 되는 부분 명시
(파랑) // ? : 의문점이 생기는 부분 명시
(주황) // Todo : 각자 자유롭게 사용
  • bracket({}) 규칙: if문의 중괄호는 여러 줄로 작성
  • if () { } else { }
  • DB 이름 (스키마): 데이터베이스 명은 영어 대문자, 길이는 8자 이내로 구성합니다.
  • 테이블
    • 테이블명은 Pascal Case로 작성
    • 테이블 column명은 CamelCase로 작성
    • 외래키 field명은 PascalCase로 작성 (i.e. UserId)
    • 관계 field명은 PascalCase로 작성 (i.e. User)
  • 참고자료

https://github.com/gyoogle/tech-interview-for-developer/blob/master/ETC/Git%20Commit%20Message%20Convention.md

저작자표시