Skip to content

Telbby 컨벤션

Yunseo Hwang edited this page Nov 24, 2021 · 5 revisions

커밋 컨벤션

[#n] type: title

ex : [#67] refactor: 컴포넌트 폴더 구조 변경

브랜치 컨벤션

type/#n

Type

Branch

Name Description
main 배포용 브랜치
dev 개발용 브랜치
feature 기능 추가
fix 버그, 오류 수정
refactor 코드 개선

Commit

New Feature feat: Description 비고
Style / Mark up style: 퍼블리싱 작업
Bug Fix fix: 버그, 오류 수정
Refactor Code refactor: 기능을 추가하지 않고 기존 코드 개선
Build / Package Update chore: 패키지 추가 등 소스코드외의 작업
New Feature feat: 코드레벨에서의 새로운 기능 추가
Documentation docs: 문서 수정
Test test: 테스트 코드 관련 작업 +10월 27일 추가

네이밍 컨벤션

backend 폴더/파일명 : kebab-case

frontend 폴더/파일명 : camelCase

변수명 : camel case

객체리터럴 : camelCase

상수 : 대문자 GNU Naming Convention (THIS_IS_CONSTANT)

boolean값 : isTrue

생성자 함수 / 클래스 / 컴포넌트명 / enum : pascal case

enum :

enum Direction {
  Up = 1,
  Down,
  Left,
  Right,
}

코드 컨벤션

테스트 코드

  • 테스트 코드 description에 한글을 허용합니다.

기타 사항

Github Issue 사용

Clone this wiki locally