네이밍 규칙
•
함수명, 변수명 : cammelCase
•
클래스, 컴포넌트 : PascalCase
•
상수 : UPPERCASE_SNAKE_CASE
•
이미지 이름 : '형태_의미_상태' 순서
◦
btn_register_on.png
◦
btn_register_off.png
Commit 컨벤션
Type | 내용 |
[feat] | 새로운 기능 추가 |
[fix] | 버그 수정 |
[refactor] | 코드 리팩토링 |
[style] | 코드 의미에 영향을 주지 않는 변경사항 (형식 지정, 세미콜론 누락 등) |
[docs] | 문서의 추가, 수정, 삭제 |
[resource] | 코드와 상관 없는 이미지 리소스 추가 |
[test] | 테스트 추가, 수정, 삭제 (비즈니스 로직에 변경 없음) |
️ [chore] | 기타 변경사항 (빌드 부분 혹은 패키지 매니저 수정사항) |
Commit 예시
•
[feat] #5 : 로그인 기능 추가
•
[docs] #noissue : Update README.md
Branch 컨벤션
•
Branch 이름 : feat/${영역}-${대분류}-${중분류}-${소분류}
◦
소분류는 optional! 필요하면 추가해요.
◦
snake_case로 작성해요.
◦
예시) feat/FE-home-main
PR 컨벤션
•
PR 제목 : [Domain]${대분류} - ${중분류} - ${소분류}
◦
예시) [FE] 홈 페이지 - 메인 - 레이아웃
•
Assignees : 도움을 받거나 같이 작업한 경우에 추가해요.
•
Conflict : 충돌이 발생할 경우 유연하게 대화를 통해 해결해요.
•
PR Rule
◦
FE : 중분류 또는 소분류 단위의 PR을 생성해요.
▪
단, 중분류의 작업 내역이 클 경우 컴포넌트 단위로 PR을 생성해요.
◦
BE : 소분류 단위의 PR을 생성해요.
### 관련 이슈
### 작업 사항
- [x] 완료 목록
- [ ] 진행중 목록
### 작업 요약
> 이곳에 요약 내용을 쓰세요.
### 첨부
> 작업한 사진을 첨부할 경우 여기에 추가하세요.
### 참고자료
> 개발할 때 참고한 자료를 첨부할 경우 여기에 추가하세요.
Plain Text
복사
Issue 컨벤션
•
Issue 제목 : [Domain]${대분류} - ${중분류} - ${소분류}
◦
예시) [FE] 홈 페이지 - 메인 - 레이아웃
## 기능 설명
## 완료 조건
- [ ] 완료 조건 1
- [ ] 완료 조건 2
Plain Text
복사