우리팀 컨벤션

개발 환경

📚Git 전략

브랜치 전략 : Git-flow

• release branch
  • 메인으로 Dev branch을 merge하여 배포를 주기적으로 합니다.
• dev branch
  • 개발은 Dev branch에서 브랜치입니다.
• issue 세세하게 작성
  • issue는 하나의 기능보다도 더 상세하게 작성하도록 합니다.
• feature 단위로 issue 맡아서
  • feature 브랜치는 issue와 매칭되도록 생성합니다.(feat/#2)

코딩 컨벤션

파일 이름

• 이름은 소문자, 숫자, 언더스코어(_)의 조합으로 작성하며, 시작은 소문자로만 작성한다. ic_button_back.svg

변수 네이밍 규칙

• 카멜 표기법을 원칙으로 한다.

1. ✅ navCloseButtonRef
2. closeNavButtonRef
3. buttonCloseNavRef

• 상수는 영문 대문자 스네이크 표기법을 사용한다.

STATUS_OK
STATUS_BAD_REQUEST

• 배열의 이름은 복수형으로 만든다.

1. chatList
2. chatArray
3. ✅ chats

• 이벤트 핸들러는 'handle'으로 시작한다.

1. ✅ handleLoginClicked
2. ✅ handleMousedown

• 반환 값이 boolean형인 함수는 'is'로 시작한다.
• 매직넘버 금지!
• const는 let보다 상단에 작성한다. → 가독성이 높아진다.
• const와 let은 사용 시점에 선언 및 할당한다. = 그룹화
• 선언과 할당을 동시에 하는 변수를, 선언만 하는 변수보다 먼저 선언한다.
• 외부 모듈과 내부 모듈을 구분하여 사용하며 선언 사이에 공백을 둔다.
• 비동기는 Async/Await 패턴 사용(체이닝 x)

참고자료

boostcamp-2020/Project18-D-WEB-Boostact

커밋 컨벤션

# <타입>: <제목> (#1)

##### 제목은 최대 50 글자까지만 입력 ############## -> |


# 본문은 위에 작성
######## 본문은 한 줄에 최대 72 글자까지만 입력 ########################### -> |
# --- COMMIT END ---
# <타입> 리스트
#   feat    : 기능 (새로운 기능)
#   fix     : 버그 (버그 수정)
#   refactor: 리팩토링
#   style   : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs    : 문서 (문서 추가, 수정, 삭제)
#   test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore   : 기타 변경사항 (빌드 스크립트 수정 등)
# ------------------
#     타입은 영어로 작성하고 제목과 본문은 한글로 작성한다.
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
#     관련된 이슈번호는 제목 맨 뒤에 추가한다. ex. (#1)
# ------------------