컨벤션 정하기 (커밋, 변수명 등)

[PreOnBoarding-Team17]

🌟 커밋 컨벤션

Type 규칙

제목의 type은 영문, 소문자로 작성합니다.

[type] [#issueNumber]: [내용]

예제

(이슈번호 있는 경우) feat #999: UML 작성
(이슈번호 없는 경우) refactor: 전반적인 코드 수정

Type 목록

feat: 파일, 폴더, 새로운 기능 추가
fix: 버그 수정
style: 코드 스타일 변경
docs: 문서 생성, 추가, 수정 README.md
refactor: 코드 리팩토링
chore: 수정 (JSON 데이터 포맷 변경 / css 변경 등)

🌟 코딩 컨벤션

Function

• 동사 + 명사
• camelCase
• 컴포넌트 만들 때 함수형 컴포넌트 정의와 export 선언은 따로 작성

const SomeComponent: React.FC<SomeInterface> = () => {
  return ();
}

export default SomeComponent;

Interface

• props 의 Interface 를 선언할때 : [컴포넌트명]Props ( ex : ChatProps )
  • props 의 Interface 의 경우 해당 컴포넌트 파일 상단에 Interface 정의
• 기본 Interface 의 경우 : [이름]Interface ( ex: UserInterface )
• 앞글자는 대문자로

Type

• [이름]Type ( ex : ReplyType )
• 앞글자는 대문자로

Contant, Redux Action Type

• 대문자가 기본, 언더바(_)로 단어 구분

🌟 브랜치

• 기능 추가의 경우 feature/ 를 붙이고 그 뒤에 소문자로 브랜치이름을 작성
• 단어를 두개이상 써야하는 경우에는 대시(-)로 구분
• 작업한 feature 브랜치는 dev 로 merge