Rule
Commit
- [feat] : 새로운 기능 추가
- [fix] : 버그를 고친 경우
- [design] : CSS 등 사용자 UI 디자인 변경
- [style] : 코드 포맷변경, 세미콜론 누락, 코드 수정이 없는 경우
- [refactor] : 프로덕션 코드 리팩토링할 경우
- [comment] : 주석 추가 및 변경
- [docs] : 문서를 수정한 경우
- [test] : 테스트 코드 작업
- [chore] : 빌드 테스트 업데이트, 패키지 매니저 설정
- [rename] : 파일 혹은 폴더명 수정
- [remove] : 삭제 작업
- [init] : 브랜치 초기화 및 초기 세팅
ex)
[feat] Question 삭제 기능 구현
[fix] Comment 추가 에러 해결
Pull Request
ex)
[feat] 로그인 기능 추가
[fix] 질문 삭제 에러 해결
- 테스트 완료 후 PR 해주세요.
- PR의 크기가 커지지 않도록 주의해주세요.
Issue
ex)
[FE] 마이 페이지 구현
[BE] JWT 구현
[ALL] 통합 테스트
Assignee : 김연우
Task Description :
- JWT 구현
- JWT 테스트
Date : 6월 30일(금)
- 라벨을 추가해주세요.
- 작업 전 반드시 이슈를 생성해주세요.
Branch
- main : Master 브랜치
- dev : Develop 브랜치
- feat : 기능 개발 브랜치
- fix : 에러 해결 브랜치
- refactor : 기능 수정 및 리팩토링 브랜치
ex)
feat/yeonwoo/login
fix/yeonwoo/comment
- merge한 브랜치는 삭제해주세요.
Milestone
[FE/BE/ALL] 내용
ex)
[FE] 메인 페이지 구현
[BE] 코멘트 구현
[ALL] 통합 테스트
FE_CodeConvention
공통 - 길이 최대 20자 이내로 제한
| 종류 | 표기법 | 조합 |
|---|---|---|
| 변수 | camelCase | 명사 |
| ex) userDate | ||
| 함수 | camelCase | 동사 + 명사 |
| ex) getUserData | ||
| 컴포넌트 | PascalCase | 명사 |
| ex) Movie |
변수
상태 처리를 위한 변수는 is...으로 구성 ex) isOpen
idx, arr, cnt, btn과 같은 이해하기 쉬운 약자는 사용하되, 그 외에 약자는 사용하지 않음
상수들은 무조건 대문자 + (ex. MAX_LEN)
함수
이벤트핸들러 조합 : handle + 명사 + 동사 (ex. handleThreeTabClick)
이벤트핸들러를 props로 전달할때는 handle로 전달
tab depth : 4개 이하
주석 : 모두 /** */로 작성
magic number는 지양(ex. asset로 분리는 논의를 합시다)
코드 블록문들(조건문, 반복문 등)은 아래의 구조를 따르기
else if문 사용 지양
if(asd) {
asdasd
}
함수 파라미터: 3개 이하
비동기 함수는 async await을 사용
비동기 Ajax 방식은 fetch를 사용
컴포넌트, 함수는 arrow
arrow 함수는 소괄호 필수, 내용에는 중괄호 필수(ex. const A = () => {return})
import
상단 = React 관련 모듈(use뭐시기들)
상중단 = 라이브러리
중단 = 컴포넌트들이나 custom Hook, 외부 분리된 파일들
하단 = CSS 파일
import 요소들은 구조분해할당 방식으로 호출, 각 요소별 정렬은 영어 표준에 따름(sort)
-
import 예시
import ‘React’ from “react”
import {use뭐시기}
import 컴포뭐시기
컴포넌트 내부 구조 순서
- 상태 변수 2. 함수 3. 이벤트 핸들러 4. useEffect 5. return
BE_CodeConvention
- 변수명은 ERD와 동일하게 작성한다.
- 복합 단어로 구성된 경우 카멜 케이스를 사용한다. (ex: viewCount)
- 일반적으로 테이블명은 복수형을 사용한다. (ex: @Table(name = "members"))
- 복합 단어로 구성된 경우 스네이크 케이스를 사용한다. (ex: @Table(name = "movie_staffs"))
- 컬럼명은 소문자를 사용하고, 복합 단어로 구성된 경우 스네이크 케이스를 사용한다. (ex: @Column(name= "member_id"))
- 의미를 명확하게 전달할 수 있도록 간결하고 명료하게 작성한다.
- 코드상 변경 및 주의 부분은 주석을 추가한다.
- 주석은 명확하고 간결하게 작성한다.
- 상수는 대문자로 작성한다.
- 복합 단어로 구성된 경우 스네이크 케이스를 사용한다. (ex: private static final int MAX_RETRY_COUNT = 3)