-
Notifications
You must be signed in to change notification settings - Fork 0
Telbby 컨벤션
Yunseo Hwang edited this page Dec 13, 2021
·
5 revisions
type/#n
ex. feature/#67
Name | Description |
---|---|
main | 배포용 브랜치 |
dev | 개발용 브랜치 |
feature | 기능 추가 |
fix | 버그, 오류 수정 |
refactor | 코드 개선 |
[#n] type: title
ex. [#67] refactor: 컴포넌트 폴더 구조 변경
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일 추가 |
- frontend 폴더/파일명 : camelCase
- backend 폴더/파일명 : kebab-case
- 변수명 : camelCase
- 객체리터럴 : camelCase
- 상수 : 대문자 GNU Naming Convention (THIS_IS_CONSTANT)
- boolean값 : isTrue
- 생성자 함수 / 클래스 / 컴포넌트명 / enum : PascalCase
- 제네릭 타입 네이밍 :
T
suffix 사용 - exRequestT
,FooBarT
// enum example
enum Direction {
Up = 1,
Down,
Left,
Right,
}
- 테스트 코드 description에 한글을 허용합니다.
- 스타일 분리 : 공통 스타일은 따로 빼고, 독립적인 스타일은 태그 선택자로
- prefix : css 스타일이니까 붙이지 않는다 / suffix : -Style
- Kanban Board : Github Projects
- Task 관리 : Github Issues